ClearML/wexpect-venv
1
0
Fork 0
mirror of https://github.com/clearml/wexpect-venv synced 2025-06-04 03:48:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[CLN] logging levels; [FIX] Pipe avail bytes

Browse Source
This commit is contained in:
Benedek Racz 2020-01-22 16:59:24 +01:00
parent eda36aa1a1
commit 149ef50874
3 changed files with 66 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
wexpect/console_reader.py
View File

@ -163,6 +163,10 @@ class ConsoleReaderBase:
cursorPos = consinfo['CursorPosition'] cursorPos = consinfo['CursorPosition']
self.send_to_host(self.readConsoleToCursor()) self.send_to_host(self.readConsoleToCursor())
s = self.get_from_host() s = self.get_from_host()
if s:
logger.debug(f'get_from_host: {s}')
else:
logger.spam(f'get_from_host: {s}')
self.write(s) self.write(s)
if cursorPos.Y > maxconsoleY and not paused: if cursorPos.Y > maxconsoleY and not paused:
@ -349,14 +353,14 @@ class ConsoleReaderBase:
consinfo = self.consout.GetConsoleScreenBufferInfo() consinfo = self.consout.GetConsoleScreenBufferInfo()
cursorPos = consinfo['CursorPosition'] cursorPos = consinfo['CursorPosition']
logger.debug('cursor: %r, current: %r' % (cursorPos, self.__currentReadCo)) logger.spam('cursor: %r, current: %r' % (cursorPos, self.__currentReadCo))
isSameX = cursorPos.X == self.__currentReadCo.X isSameX = cursorPos.X == self.__currentReadCo.X
isSameY = cursorPos.Y == self.__currentReadCo.Y isSameY = cursorPos.Y == self.__currentReadCo.Y
isSamePos = isSameX and isSameY isSamePos = isSameX and isSameY
logger.debug('isSameY: %r' % isSameY) logger.spam('isSameY: %r' % isSameY)
logger.debug('isSamePos: %r' % isSamePos) logger.spam('isSamePos: %r' % isSamePos)
if isSameY or not self.lastReadData.endswith('\r\n'): if isSameY or not self.lastReadData.endswith('\r\n'):
# Read the current slice again # Read the current slice again
@ -364,7 +368,7 @@ class ConsoleReaderBase:
self.__currentReadCo.X = 0 self.__currentReadCo.X = 0
self.__currentReadCo.Y = self.__bufferY self.__currentReadCo.Y = self.__bufferY
logger.debug('cursor: %r, current: %r' % (cursorPos, self.__currentReadCo)) logger.spam('cursor: %r, current: %r' % (cursorPos, self.__currentReadCo))
raw = self.readConsole(self.__currentReadCo, cursorPos) raw = self.readConsole(self.__currentReadCo, cursorPos)
rawlist = [] rawlist = []
@ -379,11 +383,14 @@ class ConsoleReaderBase:
self.__bufferY += len(rawlist) - i self.__bufferY += len(rawlist) - i
break break
logger.debug('lastReadData: %r' % self.lastReadData) logger.spam('lastReadData: %r' % self.lastReadData)
logger.debug('s: %r' % s) if s:
logger.debug('Read: %r' % s)
else:
logger.spam('Read: %r' % s)
if isSamePos and self.lastReadData == s: if isSamePos and self.lastReadData == s:
logger.debug('isSamePos and self.lastReadData == s') logger.spam('isSamePos and self.lastReadData == s')
s = '' s = ''
if s: if s:
@ -450,7 +457,10 @@ class ConsoleReaderSocket(ConsoleReaderBase):
def send_to_host(self, msg): def send_to_host(self, msg):
# convert to bytes # convert to bytes
msg_bytes = str.encode(msg) msg_bytes = str.encode(msg)
logger.debug(f'Sending msg: {msg_bytes}') if msg_bytes:
logger.debug(f'Sending msg: {msg_bytes}')
else:
logger.spam(f'Sending msg: {msg_bytes}')
self.connection.sendall(msg_bytes) self.connection.sendall(msg_bytes)
def get_from_host(self): def get_from_host(self):
@ -475,7 +485,7 @@ class ConsoleReaderSocket(ConsoleReaderBase):
class ConsoleReaderPipe(ConsoleReaderBase): class ConsoleReaderPipe(ConsoleReaderBase):
def create_connection(self, **kwargs): def create_connection(self, **kwargs):
pipe_name = 'wexpect_{}'.format(self.pid) pipe_name = 'wexpect_{}'.format(self.console_pid)
pipe_full_path = r'\\.\pipe\{}'.format(pipe_name) pipe_full_path = r'\\.\pipe\{}'.format(pipe_name)
logger.info('Start pipe server: %s', pipe_full_path) logger.info('Start pipe server: %s', pipe_full_path)
self.pipe = win32pipe.CreateNamedPipe( self.pipe = win32pipe.CreateNamedPipe(
@ -494,11 +504,15 @@ class ConsoleReaderPipe(ConsoleReaderBase):
def send_to_host(self, msg): def send_to_host(self, msg):
# convert to bytes # convert to bytes
msg_bytes = str.encode(msg) msg_bytes = str.encode(msg)
logger.debug(f'Sending msg: {msg_bytes}') if msg_bytes:
logger.debug(f'Sending msg: {msg_bytes}')
else:
logger.spam(f'Sending msg: {msg_bytes}')
win32file.WriteFile(self.pipe, msg_bytes) win32file.WriteFile(self.pipe, msg_bytes)
def get_from_host(self): def get_from_host(self):
_, _, avail = win32pipe.PeekNamedPipe(self.pipe, 4096) data, avail, bytes_left = win32pipe.PeekNamedPipe(self.pipe, 4096)
logger.spam(f'data: {data} avail:{avail} bytes_left{bytes_left}')
if avail > 0: if avail > 0:
resp = win32file.ReadFile(self.pipe, 4096) resp = win32file.ReadFile(self.pipe, 4096)
ret = resp[1] ret = resp[1]

50
wexpect/spawn.py
View File

@ -186,6 +186,7 @@ def run (command, timeout=-1, withexitstatus=False, events=None, extra_args=None
elif callback_result: elif callback_result:
break break
else: else:
logger.warning("TypeError ('The callback must be a string or function type.')")
raise TypeError ('The callback must be a string or function type.') raise TypeError ('The callback must be a string or function type.')
event_count = event_count + 1 event_count = event_count + 1
except TIMEOUT: except TIMEOUT:
@ -244,7 +245,7 @@ class SpawnBase:
self.env = env self.env = env
self.echo = echo self.echo = echo
self.maxread = maxread # max bytes to read at one time into buffer self.maxread = maxread # max bytes to read at one time into buffer
self.delaybeforesend = 0.05 # Sets sleep time used just before sending data to child. Time in seconds. self.delaybeforesend = 0.1 # Sets sleep time used just before sending data to child. Time in seconds.
self.delayafterterminate = 0.1 # Sets delay in terminate() method to allow kernel time to update process status. Time in seconds. self.delayafterterminate = 0.1 # Sets delay in terminate() method to allow kernel time to update process status. Time in seconds.
self.flag_child_finished = False self.flag_child_finished = False
self.buffer = '' # This is the read buffer. See maxread. self.buffer = '' # This is the read buffer. See maxread.
@ -254,9 +255,11 @@ class SpawnBase:
# If command is an int type then it may represent a file descriptor. # If command is an int type then it may represent a file descriptor.
if type(command) == type(0): if type(command) == type(0):
raise ExceptionPexpect ('Command is an int type. If this is a file descriptor then maybe you want to use fdpexpect.fdspawn which takes an existing file descriptor instead of a command string.') logger.warning("ExceptionPexpect('Command is an int type. If this is a file descriptor then maybe you want to use fdpexpect.fdspawn which takes an existing file descriptor instead of a command string.')")
raise ExceptionPexpect('Command is an int type. If this is a file descriptor then maybe you want to use fdpexpect.fdspawn which takes an existing file descriptor instead of a command string.')
if type (args) != type([]): if type (args) != type([]):
logger.warning("TypeError ('The argument, args, must be a list.')")
raise TypeError ('The argument, args, must be a list.') raise TypeError ('The argument, args, must be a list.')
if args == []: if args == []:
@ -577,6 +580,7 @@ class SpawnBase:
elif type(p) is type(re.compile('')): elif type(p) is type(re.compile('')):
compiled_pattern_list.append(p) compiled_pattern_list.append(p)
else: else:
logger.warning("TypeError ('Argument must be one of StringTypes, EOF, TIMEOUT, SRE_Pattern, or a list of those type. %s' % str(type(p)))")
raise TypeError ('Argument must be one of StringTypes, EOF, TIMEOUT, SRE_Pattern, or a list of those type. %s' % str(type(p))) raise TypeError ('Argument must be one of StringTypes, EOF, TIMEOUT, SRE_Pattern, or a list of those type. %s' % str(type(p)))
return compiled_pattern_list return compiled_pattern_list
@ -694,6 +698,7 @@ class SpawnBase:
for p in pattern_list: for p in pattern_list:
if type(p) not in (str,) and p not in (TIMEOUT, EOF): if type(p) not in (str,) and p not in (TIMEOUT, EOF):
logger.warning('Argument must be one of StringTypes, EOF, TIMEOUT, or a list of those type. %s' % str(type(p)))
raise TypeError ('Argument must be one of StringTypes, EOF, TIMEOUT, or a list of those type. %s' % str(type(p))) raise TypeError ('Argument must be one of StringTypes, EOF, TIMEOUT, or a list of those type. %s' % str(type(p)))
return self.expect_loop(searcher_string(pattern_list), timeout, searchwindowsize) return self.expect_loop(searcher_string(pattern_list), timeout, searchwindowsize)
@ -729,6 +734,7 @@ class SpawnBase:
return self.match_index return self.match_index
# No match at this point # No match at this point
if timeout is not None and end_time < time.time(): if timeout is not None and end_time < time.time():
logger.info('Timeout exceeded in expect_any().')
raise TIMEOUT ('Timeout exceeded in expect_any().') raise TIMEOUT ('Timeout exceeded in expect_any().')
# Still have time left, so read more data # Still have time left, so read more data
c = self.read_nonblocking(self.maxread) c = self.read_nonblocking(self.maxread)
@ -747,7 +753,8 @@ class SpawnBase:
else: else:
self.match = None self.match = None
self.match_index = None self.match_index = None
raise EOF (str(e) + '\n' + str(self)) logger.info(f'EOF: {e}\n{self}')
raise EOF(f'{e}\n{self}')
except TIMEOUT as e: except TIMEOUT as e:
self.buffer = incoming self.buffer = incoming
self.before = incoming self.before = incoming
@ -760,7 +767,8 @@ class SpawnBase:
else: else:
self.match = None self.match = None
self.match_index = None self.match_index = None
raise TIMEOUT (str(e) + '\n' + str(self)) logger.info(f'TIMEOUT: {e}\n{self}')
raise TIMEOUT(f'{e}\n{self}')
except: except:
self.before = incoming self.before = incoming
self.after = None self.after = None
@ -814,7 +822,7 @@ class SpawnPipe(SpawnBase):
This is a wrapper around Wtty.read(). """ This is a wrapper around Wtty.read(). """
if self.closed: if self.closed:
logger.info('I/O operation on closed file in read_nonblocking().') logger.warning('I/O operation on closed file in read_nonblocking().')
raise ValueError ('I/O operation on closed file in read_nonblocking().') raise ValueError ('I/O operation on closed file in read_nonblocking().')
try: try:
@ -824,7 +832,7 @@ class SpawnPipe(SpawnBase):
# the last output. # the last output.
# The flag_child_finished flag shows that this is the second trial, where we raise the EOF. # The flag_child_finished flag shows that this is the second trial, where we raise the EOF.
if self.flag_child_finished: if self.flag_child_finished:
logger.info("EOF('self.flag_child_finished')") logger.info('EOF: self.flag_child_finished')
raise EOF('self.flag_child_finished') raise EOF('self.flag_child_finished')
if not self.isalive(): if not self.isalive():
self.flag_child_finished = True self.flag_child_finished = True
@ -832,7 +840,11 @@ class SpawnPipe(SpawnBase):
try: try:
s = win32file.ReadFile(self.pipe, size)[1] s = win32file.ReadFile(self.pipe, size)[1]
logger.debug(f's: {s}')
if s:
logger.debug(f'Readed: {s}')
else:
logger.spam(f'Readed: {s}')
return s.decode() return s.decode()
except pywintypes.error as e: except pywintypes.error as e:
if e.args[0] == winerror.ERROR_BROKEN_PIPE: #109 if e.args[0] == winerror.ERROR_BROKEN_PIPE: #109
@ -861,19 +873,20 @@ class SpawnPipe(SpawnBase):
if self.delaybeforesend: if self.delaybeforesend:
time.sleep(self.delaybeforesend) time.sleep(self.delaybeforesend)
try: try:
while True: if s:
win32file.WriteFile(self.pipe, b'back') logger.debug(f"Writing: {s}")
win32file.WriteFile(self.pipe, s)
logger.spam(f"WriteFile finished.")
except pywintypes.error as e: except pywintypes.error as e:
if e.args[0] == winerror.ERROR_FILE_NOT_FOUND: #2 if e.args[0] == winerror.ERROR_BROKEN_PIPE: #109
print("no pipe, trying again in a bit later") logger.info("EOF: broken pipe, bye bye")
time.sleep(0.2) raise EOF("broken pipe, bye bye")
elif e.args[0] == winerror.ERROR_BROKEN_PIPE: #109
print("broken pipe, bye bye")
elif e.args[0] == winerror.ERROR_NO_DATA: elif e.args[0] == winerror.ERROR_NO_DATA:
'''232 (0xE8) '''232 (0xE8)
The pipe is being closed. The pipe is being closed.
''' '''
print("The pipe is being closed.") logger.info("The pipe is being closed.")
raise EOF("The pipe is being closed.")
else: else:
raise raise
return len(s) return len(s)
@ -984,9 +997,12 @@ class SpawnSocket(SpawnBase):
self.flag_child_finished = True self.flag_child_finished = True
logger.info('self.isalive() == False: Child has been died, lets do a last read!') logger.info('self.isalive() == False: Child has been died, lets do a last read!')
logger.debug(f'Reading socket...')
s = self.sock.recv(size) s = self.sock.recv(size)
logger.debug(f's: {s}')
if s:
logger.debug(f'Readed: {s}')
else:
logger.spam(f'Readed: {s}')
except EOF: except EOF:
self.flag_eof = True self.flag_eof = True
raise raise

8
wexpect/wexpect_util.py
View File

@ -43,6 +43,14 @@ import sys
import os import os
import logging import logging
SPAM = 5
logging.addLevelName(SPAM, "SPAM")
def spam(self, message, *args, **kws):
if self.isEnabledFor(SPAM):
# Yes, logger takes its '*args' as 'args'.
self._log(SPAM, message, args, **kws)
logging.Logger.spam = spam
def init_logger(logger): def init_logger(logger):
try: try:
logger_level = os.environ['WEXPECT_LOGGER_LEVEL'] logger_level = os.environ['WEXPECT_LOGGER_LEVEL']