mirror of
https://github.com/KenanZhu/AutoLibrary.git
synced 2026-06-17 23:13:03 +08:00
docs(MsgBase, LibOperator): 添加并完善类文档注释
This commit is contained in:
@@ -13,6 +13,13 @@ from base.MsgBase import MsgBase
|
||||
|
||||
|
||||
class LibOperator(MsgBase):
|
||||
"""
|
||||
Base abstract class for library operation.
|
||||
|
||||
This class provides the foundation for library-related operations, inheriting
|
||||
message handling and tracing abilities from MsgBase. It serves as an abstract
|
||||
base class that must be subclassed to implement specific library functionality.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
|
||||
@@ -12,6 +12,22 @@ import queue
|
||||
|
||||
|
||||
class MsgBase:
|
||||
"""
|
||||
Base class for message and trace abilities (thread-safe).
|
||||
|
||||
This class provides the foundation for message handling and tracing
|
||||
abilities based on the provided input and output queues. It enables
|
||||
thread-safe communication between components using queue-based messaging.
|
||||
|
||||
Args:
|
||||
input_queue (queue.Queue): The input queue for receiving messages.
|
||||
output_queue (queue.Queue): The output queue for sending messages.
|
||||
|
||||
Usage:
|
||||
This class must be initialized with input and output queues. The queue
|
||||
provider (the caller of this class or its subclasses) must explicitly
|
||||
implement queue polling to retrieve and process messages.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
|
||||
Reference in New Issue
Block a user