userver: testsuite.logcapture.CaptureServer Class Reference
Loading...
Searching...
No Matches
testsuite.logcapture.CaptureServer Class Reference

Detailed Description

Definition at line 145 of file logcapture.py.

Public Member Functions

 __init__ (self, *, LogLevel log_level, collections.abc.Callable[[bytes], dict] parse_line)
 Capture server.
LogLevel default_log_level (self)
 Returns default log level specified on object creation.
list[tuple] getsocknames (self)
 Return list of server socket names.
typing.AsyncIterator[ 'CaptureServer'] start (self, host='localhost', port=0, **kwargs)
 Starts capture logs asyncio server.
 wait_for_client (self, float timeout=10.0)
 Waits for logserver client to connect.
typing.AsyncIterator[Capturecapture (self, *, LogLevel|None log_level=None, float timeout=10.0)
 Starts logs capture.

Protected Member Functions

 _handle_client (self, reader, writer)

Protected Attributes

 _log_level = log_level
 _client_cond = asyncio.Condition()
list _tasks = []
 _parse_line = parse_line
bool _started = False
list _socknames = []

Static Protected Attributes

CapturedLogs _capture | None

Constructor & Destructor Documentation

◆ __init__()

testsuite.logcapture.CaptureServer.__init__ ( self,
* ,
LogLevel log_level,
collections.abc.Callable[[bytes], dict] parse_line )

Capture server.

Definition at line 148 of file logcapture.py.

Member Function Documentation

◆ _handle_client()

testsuite.logcapture.CaptureServer._handle_client ( self,
reader,
writer )
protected

Definition at line 213 of file logcapture.py.

◆ capture()

typing.AsyncIterator[Capture] testsuite.logcapture.CaptureServer.capture ( self,
* ,
LogLevel | None log_level = None,
float timeout = 10.0 )

Starts logs capture.

Returns Capture object.

Definition at line 238 of file logcapture.py.

◆ default_log_level()

LogLevel testsuite.logcapture.CaptureServer.default_log_level ( self)

Returns default log level specified on object creation.

Definition at line 164 of file logcapture.py.

◆ getsocknames()

list[tuple] testsuite.logcapture.CaptureServer.getsocknames ( self)

Return list of server socket names.

Definition at line 168 of file logcapture.py.

◆ start()

typing.AsyncIterator['CaptureServer'] testsuite.logcapture.CaptureServer.start ( self,
host = 'localhost',
port = 0,
** kwargs )

Starts capture logs asyncio server.

Arguments are directly passed to asyncio.start_server. Server could be started only once. Capture server is returned. Server is closed when contextmanager is finished.

Definition at line 173 of file logcapture.py.

◆ wait_for_client()

testsuite.logcapture.CaptureServer.wait_for_client ( self,
float timeout = 10.0 )

Waits for logserver client to connect.

Definition at line 198 of file logcapture.py.

Member Data Documentation

◆ _capture

testsuite.logcapture.CaptureServer._capture | None
staticprotected

Definition at line 146 of file logcapture.py.

◆ _client_cond

testsuite.logcapture.CaptureServer._client_cond = asyncio.Condition()
protected

Definition at line 156 of file logcapture.py.

◆ _log_level

testsuite.logcapture.CaptureServer._log_level = log_level
protected

Definition at line 155 of file logcapture.py.

◆ _parse_line

testsuite.logcapture.CaptureServer._parse_line = parse_line
protected

Definition at line 159 of file logcapture.py.

◆ _socknames

testsuite.logcapture.CaptureServer._socknames = []
protected

Definition at line 161 of file logcapture.py.

◆ _started

bool testsuite.logcapture.CaptureServer._started = False
protected

Definition at line 160 of file logcapture.py.

◆ _tasks

testsuite.logcapture.CaptureServer._tasks = []
protected

Definition at line 158 of file logcapture.py.


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