Dev documentation

Base classes

class tew652brp.core.base.BaseAct(request_method: Callable, url: str, **extra)

Base class for actions ( requests to router ). Used to create custom actions.

Usage:

>>> class GetConnectedDevicesAct(BaseAct):
...     def __init__(self, request_method, url):
...         super().__init__(request_method, url)
...         params = {
...             'ccp_act': 'get',
...             ...,
...         }
...
>>> resp = GetConnectedDevicesAct(...).submit()

submit() → requests.models.Response

Executes a request method with parameters.

class tew652brp.core.base.BaseHandler(session: requests.sessions.Session, url: str)

Base class for handlers. Used to create custom handlers.

Usage:

>>> class GetConnectedDevicesAct(BaseAct):
...     ...
>>>
>>> class GetConnectedDevicesHandler(BaseHandler):
...     def get_connected_devices(self):
...         resp = GetConnectedDevicesAct(
...             self._session.post,
...             self._routes['get_set']
...         ).submit()
...         ... # work with response
...         return resp
...
>>> handler = GetConnectedDevicesHandler()

Client class

class tew652brp.client.Client(base_url: str)

Main interface class. Contains all handlers.

Usage:

>>> from tew652brp.client import Client
>>> client = Client("http://192.168.10.1")  # Init client session
>>> client.login.login(...) # executes login method through login handler
>>> servers = client.virtual.get_servers()  # executes get_servers method through virtual servers handler

Virtual Acts & Handler

Acts

class tew652brp.core.access.virtual.acts.DeleteServerAct(request_method: Callable, url: str, server_info: tew652brp.core.access.virtual.types.VServerInfo)

Contains setup for virtual server deletion

class tew652brp.core.access.virtual.acts.GetServersAct(request_method, url)

Contains setup to get virtual servers list.

submit()

Executes a request method with parameters.

static xml_to_vservers(xml: str) → List[tew652brp.core.access.virtual.types.VServerInfo]

Convert xml to VServerInfo.

class tew652brp.core.access.virtual.acts.UpdateServerAct(request_method, url, server_info)

Contains setup for virtual server updating

Handler

class tew652brp.core.access.virtual.handler.VirtualHandler(session, url)

Virtual server handler. Contains all needed acts. Included in the Client class ( tew652brp.client ).

delete_server(server_info: tew652brp.core.access.virtual.types.VServerInfo)

Delete server by server instance

get_servers()

Get all virtual servers

update_server(server_info: tew652brp.core.access.virtual.types.VServerInfo)

Update server by VServerInfo