-
Notifications
You must be signed in to change notification settings - Fork 42
/
gateway_base.py
1554 lines (1281 loc) · 50.1 KB
/
gateway_base.py
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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
"""
base execnet gateway code send to the other side for bootstrapping.
NOTE: aims to be compatible to Python 2.5-3.X, Jython and IronPython
:copyright: 2004-2015
:authors:
- Holger Krekel
- Armin Rigo
- Benjamin Peterson
- Ronny Pfannschmidt
- many others
"""
from __future__ import with_statement
import os
import struct
import sys
import traceback
import weakref
# NOTE that we want to avoid try/except style importing
# to avoid setting sys.exc_info() during import
#
ISPY3 = sys.version_info >= (3, 0)
if ISPY3:
from io import BytesIO
exec("do_exec = exec")
def reraise(cls, val, tb):
raise val.with_traceback(tb)
unicode = str
_long_type = int
from _thread import interrupt_main
SUBPROCESS32 = False
else:
from StringIO import StringIO as BytesIO
exec(
"def do_exec(co, loc): exec co in loc\n"
"def reraise(cls, val, tb): raise cls, val, tb\n"
)
bytes = str
_long_type = long
try:
from thread import interrupt_main
except ImportError:
interrupt_main = None
try:
import subprocess32 # NOQA
SUBPROCESS32 = True
except ImportError:
SUBPROCESS32 = False
sys.exc_clear()
# f = open("/tmp/execnet-%s" % os.getpid(), "w")
# def log_extra(*msg):
# f.write(" ".join([str(x) for x in msg]) + "\n")
class EmptySemaphore:
acquire = release = lambda self: None
def get_execmodel(backend):
if hasattr(backend, "backend"):
return backend
if backend == "thread":
importdef = {
"get_ident": ["thread::get_ident", "_thread::get_ident"],
"_start_new_thread": [
"thread::start_new_thread",
"_thread::start_new_thread",
],
"threading": ["threading"],
"queue": ["queue" if ISPY3 else "Queue"],
"sleep": ["time::sleep"],
"subprocess": ["subprocess32" if SUBPROCESS32 else "subprocess"],
"socket": ["socket"],
"_fdopen": ["os::fdopen"],
"_lock": ["threading"],
"_event": ["threading"],
}
def exec_start(self, func, args=()):
self._start_new_thread(func, args)
elif backend == "eventlet":
importdef = {
"get_ident": ["eventlet.green.thread::get_ident"],
"_spawn_n": ["eventlet::spawn_n"],
"threading": ["eventlet.green.threading"],
"queue": ["eventlet.queue"],
"sleep": ["eventlet::sleep"],
"subprocess": ["eventlet.green.subprocess"],
"socket": ["eventlet.green.socket"],
"_fdopen": ["eventlet.green.os::fdopen"],
"_lock": ["eventlet.green.threading"],
"_event": ["eventlet.green.threading"],
}
def exec_start(self, func, args=()):
self._spawn_n(func, *args)
elif backend == "gevent":
importdef = {
"get_ident": ["gevent.thread::get_ident"],
"_spawn_n": ["gevent::spawn"],
"threading": ["threading"],
"queue": ["gevent.queue"],
"sleep": ["gevent::sleep"],
"subprocess": ["gevent.subprocess"],
"socket": ["gevent.socket"],
# XXX
"_fdopen": ["gevent.fileobject::FileObjectThread"],
"_lock": ["gevent.lock"],
"_event": ["gevent.event"],
}
def exec_start(self, func, args=()):
self._spawn_n(func, *args)
else:
raise ValueError("unknown execmodel {!r}".format(backend))
class ExecModel:
def __init__(self, name):
self._importdef = importdef
self.backend = name
self._count = 0
def __repr__(self):
return "<ExecModel %r>" % self.backend
def __getattr__(self, name):
locs = self._importdef.get(name)
if locs is None:
raise AttributeError(name)
for loc in locs:
parts = loc.split("::")
loc = parts.pop(0)
try:
mod = __import__(loc, None, None, "__doc__")
except ImportError:
pass
else:
if parts:
mod = getattr(mod, parts[0])
setattr(self, name, mod)
return mod
raise AttributeError(name)
start = exec_start
def fdopen(self, fd, mode, bufsize=1):
return self._fdopen(fd, mode, bufsize)
def WorkerPool(self, hasprimary=False):
return WorkerPool(self, hasprimary=hasprimary)
def Semaphore(self, size=None):
if size is None:
return EmptySemaphore()
return self._lock.Semaphore(size)
def Lock(self):
return self._lock.RLock()
def RLock(self):
return self._lock.RLock()
def Event(self):
return self._event.Event()
def PopenPiped(self, args):
PIPE = self.subprocess.PIPE
return self.subprocess.Popen(args, stdout=PIPE, stdin=PIPE)
return ExecModel(backend)
class Reply(object):
""" reply instances provide access to the result
of a function execution that got dispatched
through WorkerPool.spawn()
"""
def __init__(self, task, threadmodel):
self.task = task
self._result_ready = threadmodel.Event()
self.running = True
def get(self, timeout=None):
""" get the result object from an asynchronous function execution.
if the function execution raised an exception,
then calling get() will reraise that exception
including its traceback.
"""
self.waitfinish(timeout)
try:
return self._result
except AttributeError:
reraise(*(self._excinfo[:3])) # noqa
def waitfinish(self, timeout=None):
if not self._result_ready.wait(timeout):
raise IOError("timeout waiting for {!r}".format(self.task))
def run(self):
func, args, kwargs = self.task
try:
try:
self._result = func(*args, **kwargs)
except:
# sys may be already None when shutting down the interpreter
if sys is not None:
self._excinfo = sys.exc_info()
finally:
self._result_ready.set()
self.running = False
class WorkerPool(object):
""" A WorkerPool allows to spawn function executions
to threads, returning a reply object on which you
can ask for the result (and get exceptions reraised).
This implementation allows the main thread to integrate
itself into performing function execution through
calling integrate_as_primary_thread() which will return
when the pool received a trigger_shutdown().
"""
def __init__(self, execmodel, hasprimary=False):
""" by default allow unlimited number of spawns. """
self.execmodel = execmodel
self._running_lock = self.execmodel.Lock()
self._running = set()
self._shuttingdown = False
self._waitall_events = []
if hasprimary:
if self.execmodel.backend != "thread":
raise ValueError("hasprimary=True requires thread model")
self._primary_thread_task_ready = self.execmodel.Event()
else:
self._primary_thread_task_ready = None
def integrate_as_primary_thread(self):
""" integrate the thread with which we are called as a primary
thread for executing functions triggered with spawn().
"""
assert self.execmodel.backend == "thread", self.execmodel
primary_thread_task_ready = self._primary_thread_task_ready
# interacts with code at REF1
while 1:
primary_thread_task_ready.wait()
reply = self._primary_thread_task
if reply is None: # trigger_shutdown() woke us up
break
self._perform_spawn(reply)
# we are concurrent with trigger_shutdown and spawn
with self._running_lock:
if self._shuttingdown:
break
primary_thread_task_ready.clear()
def trigger_shutdown(self):
with self._running_lock:
self._shuttingdown = True
if self._primary_thread_task_ready is not None:
self._primary_thread_task = None
self._primary_thread_task_ready.set()
def active_count(self):
return len(self._running)
def _perform_spawn(self, reply):
reply.run()
with self._running_lock:
self._running.remove(reply)
if not self._running:
while self._waitall_events:
waitall_event = self._waitall_events.pop()
waitall_event.set()
def _try_send_to_primary_thread(self, reply):
# REF1 in 'thread' model we give priority to running in main thread
# note that we should be called with _running_lock hold
primary_thread_task_ready = self._primary_thread_task_ready
if primary_thread_task_ready is not None:
if not primary_thread_task_ready.isSet():
self._primary_thread_task = reply
# wake up primary thread
primary_thread_task_ready.set()
return True
return False
def spawn(self, func, *args, **kwargs):
""" return Reply object for the asynchronous dispatch
of the given func(*args, **kwargs).
"""
reply = Reply((func, args, kwargs), self.execmodel)
with self._running_lock:
if self._shuttingdown:
raise ValueError("pool is shutting down")
self._running.add(reply)
if not self._try_send_to_primary_thread(reply):
self.execmodel.start(self._perform_spawn, (reply,))
return reply
def terminate(self, timeout=None):
""" trigger shutdown and wait for completion of all executions. """
self.trigger_shutdown()
return self.waitall(timeout=timeout)
def waitall(self, timeout=None):
""" wait until all active spawns have finished executing. """
with self._running_lock:
if not self._running:
return True
# if a Reply still runs, we let run_and_release
# signal us -- note that we are still holding the
# _running_lock to avoid race conditions
my_waitall_event = self.execmodel.Event()
self._waitall_events.append(my_waitall_event)
return my_waitall_event.wait(timeout=timeout)
sysex = (KeyboardInterrupt, SystemExit)
DEBUG = os.environ.get("EXECNET_DEBUG")
pid = os.getpid()
if DEBUG == "2":
def trace(*msg):
try:
line = " ".join(map(str, msg))
sys.stderr.write("[{}] {}\n".format(pid, line))
sys.stderr.flush()
except Exception:
pass # nothing we can do, likely interpreter-shutdown
elif DEBUG:
import tempfile
import os
fn = os.path.join(tempfile.gettempdir(), "execnet-debug-%d" % pid)
# sys.stderr.write("execnet-debug at %r" % (fn,))
debugfile = open(fn, "w")
def trace(*msg):
try:
line = " ".join(map(str, msg))
debugfile.write(line + "\n")
debugfile.flush()
except Exception:
try:
v = sys.exc_info()[1]
sys.stderr.write("[{}] exception during tracing: {!r}\n".format(pid, v))
except Exception:
pass # nothing we can do, likely interpreter-shutdown
else:
notrace = trace = lambda *msg: None
class Popen2IO:
error = (IOError, OSError, EOFError)
def __init__(self, outfile, infile, execmodel):
# we need raw byte streams
self.outfile, self.infile = outfile, infile
if sys.platform == "win32":
import msvcrt
try:
msvcrt.setmode(infile.fileno(), os.O_BINARY)
msvcrt.setmode(outfile.fileno(), os.O_BINARY)
except (AttributeError, IOError):
pass
self._read = getattr(infile, "buffer", infile).read
self._write = getattr(outfile, "buffer", outfile).write
self.execmodel = execmodel
def read(self, numbytes):
"""Read exactly 'numbytes' bytes from the pipe. """
# a file in non-blocking mode may return less bytes, so we loop
buf = bytes()
while numbytes > len(buf):
data = self._read(numbytes - len(buf))
if not data:
raise EOFError("expected %d bytes, got %d" % (numbytes, len(buf)))
buf += data
return buf
def write(self, data):
"""write out all data bytes. """
assert isinstance(data, bytes)
self._write(data)
self.outfile.flush()
def close_read(self):
self.infile.close()
def close_write(self):
self.outfile.close()
class Message:
""" encapsulates Messages and their wire protocol. """
_types = []
def __init__(self, msgcode, channelid=0, data=""):
self.msgcode = msgcode
self.channelid = channelid
self.data = data
@staticmethod
def from_io(io):
try:
header = io.read(9) # type 1, channel 4, payload 4
if not header:
raise EOFError("empty read")
except EOFError:
e = sys.exc_info()[1]
raise EOFError("couldnt load message header, " + e.args[0])
msgtype, channel, payload = struct.unpack("!bii", header)
return Message(msgtype, channel, io.read(payload))
def to_io(self, io):
header = struct.pack("!bii", self.msgcode, self.channelid, len(self.data))
io.write(header + self.data)
def received(self, gateway):
self._types[self.msgcode](self, gateway)
def __repr__(self):
name = self._types[self.msgcode].__name__.upper()
return "<Message {} channel={} lendata={}>".format(
name, self.channelid, len(self.data)
)
class GatewayReceivedTerminate(Exception):
""" Receiverthread got termination message. """
def _setupmessages():
def status(message, gateway):
# we use the channelid to send back information
# but don't instantiate a channel object
d = {
"numchannels": len(gateway._channelfactory._channels),
"numexecuting": gateway._execpool.active_count(),
"execmodel": gateway.execmodel.backend,
}
gateway._send(Message.CHANNEL_DATA, message.channelid, dumps_internal(d))
gateway._send(Message.CHANNEL_CLOSE, message.channelid)
def channel_exec(message, gateway):
channel = gateway._channelfactory.new(message.channelid)
gateway._local_schedulexec(channel=channel, sourcetask=message.data)
def channel_data(message, gateway):
gateway._channelfactory._local_receive(message.channelid, message.data)
def channel_close(message, gateway):
gateway._channelfactory._local_close(message.channelid)
def channel_close_error(message, gateway):
remote_error = RemoteError(loads_internal(message.data))
gateway._channelfactory._local_close(message.channelid, remote_error)
def channel_last_message(message, gateway):
gateway._channelfactory._local_close(message.channelid, sendonly=True)
def gateway_terminate(message, gateway):
raise GatewayReceivedTerminate(gateway)
def reconfigure(message, gateway):
if message.channelid == 0:
target = gateway
else:
target = gateway._channelfactory.new(message.channelid)
target._strconfig = loads_internal(message.data, gateway)
types = [
status,
reconfigure,
gateway_terminate,
channel_exec,
channel_data,
channel_close,
channel_close_error,
channel_last_message,
]
for i, handler in enumerate(types):
Message._types.append(handler)
setattr(Message, handler.__name__.upper(), i)
_setupmessages()
def geterrortext(excinfo, format_exception=traceback.format_exception, sysex=sysex):
try:
l = format_exception(*excinfo)
errortext = "".join(l)
except sysex:
raise
except:
errortext = "{}: {}".format(excinfo[0].__name__, excinfo[1])
return errortext
class RemoteError(Exception):
""" Exception containing a stringified error from the other side. """
def __init__(self, formatted):
self.formatted = formatted
Exception.__init__(self)
def __str__(self):
return self.formatted
def __repr__(self):
return "{}: {}".format(self.__class__.__name__, self.formatted)
def warn(self):
if self.formatted != INTERRUPT_TEXT:
# XXX do this better
sys.stderr.write("[%s] Warning: unhandled %r\n" % (os.getpid(), self))
class TimeoutError(IOError):
""" Exception indicating that a timeout was reached. """
NO_ENDMARKER_WANTED = object()
class Channel(object):
"Communication channel between two Python Interpreter execution points."
RemoteError = RemoteError
TimeoutError = TimeoutError
_INTERNALWAKEUP = 1000
_executing = False
def __init__(self, gateway, id):
assert isinstance(id, int)
self.gateway = gateway
# XXX: defaults copied from Unserializer
self._strconfig = getattr(gateway, "_strconfig", (True, False))
self.id = id
self._items = self.gateway.execmodel.queue.Queue()
self._closed = False
self._receiveclosed = self.gateway.execmodel.Event()
self._remoteerrors = []
def _trace(self, *msg):
self.gateway._trace(self.id, *msg)
def setcallback(self, callback, endmarker=NO_ENDMARKER_WANTED):
""" set a callback function for receiving items.
All already queued items will immediately trigger the callback.
Afterwards the callback will execute in the receiver thread
for each received data item and calls to ``receive()`` will
raise an error.
If an endmarker is specified the callback will eventually
be called with the endmarker when the channel closes.
"""
_callbacks = self.gateway._channelfactory._callbacks
with self.gateway._receivelock:
if self._items is None:
raise IOError("{!r} has callback already registered".format(self))
items = self._items
self._items = None
while 1:
try:
olditem = items.get(block=False)
except self.gateway.execmodel.queue.Empty:
if not (self._closed or self._receiveclosed.isSet()):
_callbacks[self.id] = (callback, endmarker, self._strconfig)
break
else:
if olditem is ENDMARKER:
items.put(olditem) # for other receivers
if endmarker is not NO_ENDMARKER_WANTED:
callback(endmarker)
break
else:
callback(olditem)
def __repr__(self):
flag = self.isclosed() and "closed" or "open"
return "<Channel id=%d %s>" % (self.id, flag)
def __del__(self):
if self.gateway is None: # can be None in tests
return
self._trace("channel.__del__")
# no multithreading issues here, because we have the last ref to 'self'
if self._closed:
# state transition "closed" --> "deleted"
for error in self._remoteerrors:
error.warn()
elif self._receiveclosed.isSet():
# state transition "sendonly" --> "deleted"
# the remote channel is already in "deleted" state, nothing to do
pass
else:
# state transition "opened" --> "deleted"
# check if we are in the middle of interpreter shutdown
# in which case the process will go away and we probably
# don't need to try to send a closing or last message
# (and often it won't work anymore to send things out)
if Message is not None:
if self._items is None: # has_callback
msgcode = Message.CHANNEL_LAST_MESSAGE
else:
msgcode = Message.CHANNEL_CLOSE
try:
self.gateway._send(msgcode, self.id)
except (IOError, ValueError): # ignore problems with sending
pass
def _getremoteerror(self):
try:
return self._remoteerrors.pop(0)
except IndexError:
try:
return self.gateway._error
except AttributeError:
pass
return None
#
# public API for channel objects
#
def isclosed(self):
""" return True if the channel is closed. A closed
channel may still hold items.
"""
return self._closed
def makefile(self, mode="w", proxyclose=False):
""" return a file-like object.
mode can be 'w' or 'r' for writeable/readable files.
if proxyclose is true file.close() will also close the channel.
"""
if mode == "w":
return ChannelFileWrite(channel=self, proxyclose=proxyclose)
elif mode == "r":
return ChannelFileRead(channel=self, proxyclose=proxyclose)
raise ValueError("mode {!r} not availabe".format(mode))
def close(self, error=None):
""" close down this channel with an optional error message.
Note that closing of a channel tied to remote_exec happens
automatically at the end of execution and cannot
be done explicitely.
"""
if self._executing:
raise IOError("cannot explicitly close channel within remote_exec")
if self._closed:
self.gateway._trace(self, "ignoring redundant call to close()")
if not self._closed:
# state transition "opened/sendonly" --> "closed"
# threads warning: the channel might be closed under our feet,
# but it's never damaging to send too many CHANNEL_CLOSE messages
# however, if the other side triggered a close already, we
# do not send back a closed message.
if not self._receiveclosed.isSet():
put = self.gateway._send
if error is not None:
put(Message.CHANNEL_CLOSE_ERROR, self.id, dumps_internal(error))
else:
put(Message.CHANNEL_CLOSE, self.id)
self._trace("sent channel close message")
if isinstance(error, RemoteError):
self._remoteerrors.append(error)
self._closed = True # --> "closed"
self._receiveclosed.set()
queue = self._items
if queue is not None:
queue.put(ENDMARKER)
self.gateway._channelfactory._no_longer_opened(self.id)
def waitclose(self, timeout=None):
""" wait until this channel is closed (or the remote side
otherwise signalled that no more data was being sent).
The channel may still hold receiveable items, but not receive
any more after waitclose() has returned. Exceptions from executing
code on the other side are reraised as local channel.RemoteErrors.
EOFError is raised if the reading-connection was prematurely closed,
which often indicates a dying process.
self.TimeoutError is raised after the specified number of seconds
(default is None, i.e. wait indefinitely).
"""
# wait for non-"opened" state
self._receiveclosed.wait(timeout=timeout)
if not self._receiveclosed.isSet():
raise self.TimeoutError("Timeout after %r seconds" % timeout)
error = self._getremoteerror()
if error:
raise error
def send(self, item):
"""sends the given item to the other side of the channel,
possibly blocking if the sender queue is full.
The item must be a simple python type and will be
copied to the other side by value. IOError is
raised if the write pipe was prematurely closed.
"""
if self.isclosed():
raise IOError("cannot send to {!r}".format(self))
self.gateway._send(Message.CHANNEL_DATA, self.id, dumps_internal(item))
def receive(self, timeout=None):
"""receive a data item that was sent from the other side.
timeout: None [default] blocked waiting. A positive number
indicates the number of seconds after which a channel.TimeoutError
exception will be raised if no item was received.
Note that exceptions from the remotely executing code will be
reraised as channel.RemoteError exceptions containing
a textual representation of the remote traceback.
"""
itemqueue = self._items
if itemqueue is None:
raise IOError("cannot receive(), channel has receiver callback")
try:
x = itemqueue.get(timeout=timeout)
except self.gateway.execmodel.queue.Empty:
raise self.TimeoutError("no item after %r seconds" % timeout)
if x is ENDMARKER:
itemqueue.put(x) # for other receivers
raise self._getremoteerror() or EOFError()
else:
return x
def __iter__(self):
return self
def next(self):
try:
return self.receive()
except EOFError:
raise StopIteration
__next__ = next
def reconfigure(self, py2str_as_py3str=True, py3str_as_py2str=False):
"""
set the string coercion for this channel
the default is to try to convert py2 str as py3 str,
but not to try and convert py3 str to py2 str
"""
self._strconfig = (py2str_as_py3str, py3str_as_py2str)
data = dumps_internal(self._strconfig)
self.gateway._send(Message.RECONFIGURE, self.id, data=data)
ENDMARKER = object()
INTERRUPT_TEXT = "keyboard-interrupted"
class ChannelFactory(object):
def __init__(self, gateway, startcount=1):
self._channels = weakref.WeakValueDictionary()
self._callbacks = {}
self._writelock = gateway.execmodel.Lock()
self.gateway = gateway
self.count = startcount
self.finished = False
self._list = list # needed during interp-shutdown
def new(self, id=None):
""" create a new Channel with 'id' (or create new id if None). """
with self._writelock:
if self.finished:
raise IOError("connexion already closed: {}".format(self.gateway))
if id is None:
id = self.count
self.count += 2
try:
channel = self._channels[id]
except KeyError:
channel = self._channels[id] = Channel(self.gateway, id)
return channel
def channels(self):
return self._list(self._channels.values())
#
# internal methods, called from the receiver thread
#
def _no_longer_opened(self, id):
try:
del self._channels[id]
except KeyError:
pass
try:
callback, endmarker, strconfig = self._callbacks.pop(id)
except KeyError:
pass
else:
if endmarker is not NO_ENDMARKER_WANTED:
callback(endmarker)
def _local_close(self, id, remoteerror=None, sendonly=False):
channel = self._channels.get(id)
if channel is None:
# channel already in "deleted" state
if remoteerror:
remoteerror.warn()
self._no_longer_opened(id)
else:
# state transition to "closed" state
if remoteerror:
channel._remoteerrors.append(remoteerror)
queue = channel._items
if queue is not None:
queue.put(ENDMARKER)
self._no_longer_opened(id)
if not sendonly: # otherwise #--> "sendonly"
channel._closed = True # --> "closed"
channel._receiveclosed.set()
def _local_receive(self, id, data):
# executes in receiver thread
channel = self._channels.get(id)
try:
callback, endmarker, strconfig = self._callbacks[id]
except KeyError:
queue = channel and channel._items
if queue is None:
pass # drop data
else:
item = loads_internal(data, channel)
queue.put(item)
else:
try:
data = loads_internal(data, channel, strconfig)
callback(data) # even if channel may be already closed
except Exception:
excinfo = sys.exc_info()
self.gateway._trace("exception during callback: %s" % excinfo[1])
errortext = self.gateway._geterrortext(excinfo)
self.gateway._send(
Message.CHANNEL_CLOSE_ERROR, id, dumps_internal(errortext)
)
self._local_close(id, errortext)
def _finished_receiving(self):
with self._writelock:
self.finished = True
for id in self._list(self._channels):
self._local_close(id, sendonly=True)
for id in self._list(self._callbacks):
self._no_longer_opened(id)
class ChannelFile(object):
def __init__(self, channel, proxyclose=True):
self.channel = channel
self._proxyclose = proxyclose
def isatty(self):
return False
def close(self):
if self._proxyclose:
self.channel.close()
def __repr__(self):
state = self.channel.isclosed() and "closed" or "open"
return "<ChannelFile %d %s>" % (self.channel.id, state)
class ChannelFileWrite(ChannelFile):
def write(self, out):
self.channel.send(out)
def flush(self):
pass
class ChannelFileRead(ChannelFile):
def __init__(self, channel, proxyclose=True):
super(ChannelFileRead, self).__init__(channel, proxyclose)
self._buffer = None
def read(self, n):
try:
if self._buffer is None:
self._buffer = self.channel.receive()
while len(self._buffer) < n:
self._buffer += self.channel.receive()
except EOFError:
self.close()
if self._buffer is None:
ret = ""
else:
ret = self._buffer[:n]
self._buffer = self._buffer[n:]
return ret
def readline(self):
if self._buffer is not None:
i = self._buffer.find("\n")
if i != -1:
return self.read(i + 1)
line = self.read(len(self._buffer) + 1)
else:
line = self.read(1)
while line and line[-1] != "\n":
c = self.read(1)
if not c:
break
line += c
return line
class BaseGateway(object):
exc_info = sys.exc_info
_sysex = sysex
id = "<worker>"
def __init__(self, io, id, _startcount=2):
self.execmodel = io.execmodel
self._io = io
self.id = id
self._strconfig = (Unserializer.py2str_as_py3str, Unserializer.py3str_as_py2str)
self._channelfactory = ChannelFactory(self, _startcount)
self._receivelock = self.execmodel.RLock()
# globals may be NONE at process-termination
self.__trace = trace
self._geterrortext = geterrortext
self._receivepool = self.execmodel.WorkerPool()
def _trace(self, *msg):
self.__trace(self.id, *msg)
def _initreceive(self):
self._receivepool.spawn(self._thread_receiver)
def _thread_receiver(self):
def log(*msg):
self._trace("[receiver-thread]", *msg)
log("RECEIVERTHREAD: starting to run")
io = self._io
try:
while 1:
msg = Message.from_io(io)
log("received", msg)
with self._receivelock:
msg.received(self)
del msg
except (KeyboardInterrupt, GatewayReceivedTerminate):
pass
except EOFError:
log("EOF without prior gateway termination message")
self._error = self.exc_info()[1]
except Exception:
log(self._geterrortext(self.exc_info()))
log("finishing receiving thread")
# wake up and terminate any execution waiting to receive
self._channelfactory._finished_receiving()
log("terminating execution")
self._terminate_execution()
log("closing read")
self._io.close_read()
log("closing write")
self._io.close_write()
log("terminating our receive pseudo pool")
self._receivepool.trigger_shutdown()
def _terminate_execution(self):
pass
def _send(self, msgcode, channelid=0, data=bytes()):
message = Message(msgcode, channelid, data)
try:
message.to_io(self._io)
self._trace("sent", message)
except (IOError, ValueError):
e = sys.exc_info()[1]