msa.api package

Submodules

msa.api.api_clients module

msa.api.base_methods module

msa.api.base_methods.check_connection(self)

Raises an exception if the cli cannot contact the daemon.

Async: Returns:None

msa.api.base_methods.check_version(self, quiet=False)

Called automatically at startup, ensures that the cli version and the daemon versions match.

Async: Parameters:quiet (bool) – Print’s the response of True. Returns:None

msa.api.base_methods.get_version(self)

Fetches the daemon’s version.

Async: Returns:None

msa.api.base_methods.ping(self, quiet=False)

Send’s a ping to the daemon. If the ping succeeds, you should see a pong response.

Async: Parameters:quiet (bool) – Print’s the response of True. Returns:None

msa.api.base_methods.register_base_methods(api_wrapper)

msa.api.context module

class msa.api.context.ApiContext

Bases: enum.Enum

An enumeration.

local = 0

rest = 1

websocket = 2

msa.api.patchable_api module

class msa.api.patchable_api.MsaApi(*args, **kwargs)

Bases: dict

msa.api.patcher module

class msa.api.patcher.ApiPatcher(api_context, api_client, plugin_whitelist)

Bases: object

cache = {}

static load(api_context, api_client=None, plugin_whitelist=None)

register_method()

Module contents