esptest.adapter.port.shell_port module

class esptest.adapter.port.shell_port.ShellRaw(cmd='', env=None)[source]

Bases: RawPort

A subprocess Raw Port class that supports shell read, write

is a subclass of RawPort

Parameters:

cmd (str | List[str])
env (Dict[str, str] | None)

open()[source]

Return type:: None

close()[source]

Close subprocess.

Return type:: None

write_bytes(data)[source]

Write bytes to subprocess stdin.

Parameters:: data (bytes)
Return type:: None

read_bytes(timeout=0)[source]

blocking read bytes

Parameters:: timeout (float)
Return type:: bytes

read_bytes_nonblocking(size=-1)[source]

non-blocking read bytes

Parameters:: size (int)
Return type:: bytes

class esptest.adapter.port.shell_port.ShellPort(cmd='/bin/bash', env=None, name='', log_file='', **kwargs)[source]

Bases: BasePort[ShellRaw]

A combined port class that supports shell read, write, expect

Parameters:

cmd (str)
env (Dict[str, str] | None)
name (str)
log_file (str)
kwargs (Any)

property is_alive: bool

class esptest.adapter.port.shell_port.InvalidRaw[source]

Bases: RawPort

A invalid Raw Port class that always raise NotImplementedError to pass type check

write_bytes(data)[source]

Write bytes to subprocess stdin.

Parameters:: data (bytes)
Return type:: None

read_bytes(timeout=0)[source]

blocking read bytes

Parameters:: timeout (float)
Return type:: bytes

class esptest.adapter.port.shell_port.PexpectPort(cmd='/bin/bash', name='', log_file='', **kwargs)[source]

Bases: BasePort[InvalidRaw]

A pexpect Port class that supports shell read, write, expect

based on pexpect.spawn but use different expect method

Parameters:

cmd (str)
name (str)
log_file (str)
kwargs (Any)

property log_file: str: Get Current dut log file.

property spawn: spawn | None: Allow the use of pexpect spawn enhancements, if pexpect process is available

start_redirect_thread()[source]

Start a new thread to read data from port and save to data cache.

Return type:: None

stop_redirect_thread()[source]

Stop the redirect thread and pexpect process.

Return type:: bool

close()[source]

Close pexpect process.

Return type:: None