Inheritance diagram for microscope.testsuite.mock_devices.SerialMock:

Public Member Functions
	__init__ (self, args, *kwargs)

	open (self)

	close (self)

	handle (self, command)

	write (self, data)

	read (self, size=1)

	readline (self, size=-1)

	reset_input_buffer (self)

	reset_output_buffer (self)

Public Attributes
	in_buffer = io.BytesIO()

	out_buffer = io.BytesIO()

int	out_pending_bytes = 0

int	out_parsed_bytes = 0

int	in_read_bytes = 0

	eol = self.out_buffer.read(self.out_pending_bytes)

Protected Member Functions
	_readx_wrapper (self, reader, args, *kwargs)

Detailed Description

Base class to mock devices controlled via serial.

It has two :class:`io.BytesIO` buffers.  One :func:`write`s the
output buffer and the other :func:`read`s the input buffer.  After
a write, the output buffer is analysed for a command.  If there is
a command, stuff gets done.  This usually means adding to the
input buffer and changing state of the device.

Definition at line 38 of file mock_devices.py.

Constructor & Destructor Documentation

◆ init()

microscope.testsuite.mock_devices.SerialMock.__init__	(		self,
		*	args,
		**	kwargs )

Definition at line 49 of file mock_devices.py.

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.in_buffer = io.BytesIO()
        self.out_buffer = io.BytesIO()
 
        # Number of bytes in out buffer pending 'interpretation'.  A
        # command is only interpreted and handled when EOL is seen.
        self.out_pending_bytes = 0
        self.out_parsed_bytes = 0
 
        # Number of bytes in the input buffer that have been read
        self.in_read_bytes = 0
 

Member Function Documentation

◆ _readx_wrapper()

microscope.testsuite.mock_devices.SerialMock._readx_wrapper	(		self,
			reader,
		*	args,
		**	kwargs )

protected

Place pointer of input buffer before and after read methods

Definition at line 86 of file mock_devices.py.

    def _readx_wrapper(self, reader, *args, **kwargs):
        """Place pointer of input buffer before and after read methods"""
        self.in_buffer.seek(self.in_read_bytes)
        msg = reader(*args, **kwargs)
        self.in_read_bytes += len(msg)
        return msg
 

◆ close()

microscope.testsuite.mock_devices.SerialMock.close ( self )

Definition at line 65 of file mock_devices.py.

    def close(self):
        self.in_buffer.close()
        self.out_buffer.close()
 

◆ handle()

microscope.testsuite.mock_devices.SerialMock.handle	(		self,
			command )

Definition at line 69 of file mock_devices.py.

    def handle(self, command):
        raise NotImplementedError("sub classes need to implement handle()")
 

◆ open()

microscope.testsuite.mock_devices.SerialMock.open ( self )

Definition at line 62 of file mock_devices.py.

    def open(self):
        pass
 

◆ read()

microscope.testsuite.mock_devices.SerialMock.read	(		self,
			size = 1 )

Definition at line 93 of file mock_devices.py.

    def read(self, size=1):
        return self._readx_wrapper(self.in_buffer.read, size)
 

◆ readline()

microscope.testsuite.mock_devices.SerialMock.readline	(		self,
			size = -1 )

Definition at line 96 of file mock_devices.py.

    def readline(self, size=-1):
        return self._readx_wrapper(self.in_buffer.readline, size)
 

◆ reset_input_buffer()

microscope.testsuite.mock_devices.SerialMock.reset_input_buffer ( self )

Definition at line 99 of file mock_devices.py.

    def reset_input_buffer(self):
        self.in_read_bytes = self.in_buffer.getbuffer().nbytes
        self.in_buffer.seek(0, 2)
 

◆ reset_output_buffer()

microscope.testsuite.mock_devices.SerialMock.reset_output_buffer ( self )

Definition at line 103 of file mock_devices.py.

    def reset_output_buffer(self):
        pass

◆ write()

microscope.testsuite.mock_devices.SerialMock.write	(		self,
			data )

Definition at line 72 of file mock_devices.py.

    def write(self, data):
        self.out_buffer.write(data)
        self.out_pending_bytes += len(data)
 
        if self.out_pending_bytes > len(data):
            # we need to retrieve data from a previous write
            self.out_buffer.seek(-self.out_pending_bytes, 2)
            data = self.out_buffer.read(self.out_pending_bytes)
 
        for msg in data.split(self.eol)[:-1]:
            self.handle(msg)
            self.out_pending_bytes -= len(msg) + len(self.eol)
        return len(data)
 

Member Data Documentation

◆ eol

microscope.testsuite.mock_devices.SerialMock.eol = self.out_buffer.read(self.out_pending_bytes)

Definition at line 81 of file mock_devices.py.

◆ in_buffer

microscope.testsuite.mock_devices.SerialMock.in_buffer = io.BytesIO()

Definition at line 51 of file mock_devices.py.

◆ in_read_bytes

microscope.testsuite.mock_devices.SerialMock.in_read_bytes = 0

Definition at line 60 of file mock_devices.py.

◆ out_buffer

microscope.testsuite.mock_devices.SerialMock.out_buffer = io.BytesIO()

Definition at line 52 of file mock_devices.py.

◆ out_parsed_bytes

int microscope.testsuite.mock_devices.SerialMock.out_parsed_bytes = 0

Definition at line 57 of file mock_devices.py.

◆ out_pending_bytes

microscope.testsuite.mock_devices.SerialMock.out_pending_bytes = 0

Definition at line 56 of file mock_devices.py.

The documentation for this class was generated from the following file:

BioImager/PythonMicroscope/microscope/testsuite/mock_devices.py

Public Member Functions

Public Attributes

Protected Member Functions