Add docstring for init request manager

This commit is contained in:
Marek Wolan
2024-03-11 10:20:47 +00:00
parent 66ab5ec980
commit 1faefbccac
14 changed files with 80 additions and 0 deletions

View File

@@ -37,6 +37,11 @@ class DatabaseClient(Application):
super().__init__(**kwargs)
def _init_request_manager(self) -> RequestManager:
"""
Initialise the request manager.
More information in user guide and docstring for SimComponent._init_request_manager.
"""
rm = super()._init_request_manager()
rm.add_request("execute", RequestType(func=lambda request, context: RequestResponse.from_bool(self.execute())))
return rm

View File

@@ -75,6 +75,11 @@ class DataManipulationBot(Application):
return db_client
def _init_request_manager(self) -> RequestManager:
"""
Initialise the request manager.
More information in user guide and docstring for SimComponent._init_request_manager.
"""
rm = super()._init_request_manager()
rm.add_request(

View File

@@ -58,6 +58,11 @@ class DoSBot(DatabaseClient):
self.max_sessions = 1000 # override normal max sessions
def _init_request_manager(self) -> RequestManager:
"""
Initialise the request manager.
More information in user guide and docstring for SimComponent._init_request_manager.
"""
rm = super()._init_request_manager()
rm.add_request(

View File

@@ -51,6 +51,11 @@ class WebBrowser(Application):
self.run()
def _init_request_manager(self) -> RequestManager:
"""
Initialise the request manager.
More information in user guide and docstring for SimComponent._init_request_manager.
"""
rm = super()._init_request_manager()
rm.add_request(
name="execute",

View File

@@ -80,6 +80,11 @@ class Service(IOSoftware):
return super().receive(payload=payload, session_id=session_id, **kwargs)
def _init_request_manager(self) -> RequestManager:
"""
Initialise the request manager.
More information in user guide and docstring for SimComponent._init_request_manager.
"""
rm = super()._init_request_manager()
rm.add_request("scan", RequestType(func=lambda request, context: RequestResponse.from_bool(self.scan())))
rm.add_request("stop", RequestType(func=lambda request, context: RequestResponse.from_bool(self.stop())))

View File

@@ -102,6 +102,11 @@ class Software(SimComponent):
"Current number of ticks left to patch the software."
def _init_request_manager(self) -> RequestManager:
"""
Initialise the request manager.
More information in user guide and docstring for SimComponent._init_request_manager.
"""
rm = super()._init_request_manager()
rm.add_request(
"compromise",