changed default for return_list in api.path

This commit is contained in:
tomaae 2020-04-04 21:43:19 +02:00
parent 1ec4e13eb8
commit f489259908
2 changed files with 13 additions and 13 deletions

View file

@ -229,7 +229,7 @@ class MikrotikControllerData:
"""Get all interfaces data from Mikrotik""" """Get all interfaces data from Mikrotik"""
self.data["interface"] = parse_api( self.data["interface"] = parse_api(
data=self.data["interface"], data=self.data["interface"],
source=self.api.path("/interface", return_list=True), source=self.api.path("/interface"),
key="default-name", key="default-name",
vals=[ vals=[
{"name": "default-name"}, {"name": "default-name"},
@ -331,7 +331,7 @@ class MikrotikControllerData:
# --------------------------- # ---------------------------
def update_arp(self, mac2ip, bridge_used): def update_arp(self, mac2ip, bridge_used):
"""Get list of hosts in ARP for interface client data from Mikrotik""" """Get list of hosts in ARP for interface client data from Mikrotik"""
data = self.api.path("/ip/arp", return_list=True) data = self.api.path("/ip/arp")
if not data: if not data:
return mac2ip, bridge_used return mac2ip, bridge_used
@ -382,7 +382,7 @@ class MikrotikControllerData:
# --------------------------- # ---------------------------
def update_bridge_hosts(self, mac2ip): def update_bridge_hosts(self, mac2ip):
"""Get list of hosts in bridge for interface client data from Mikrotik""" """Get list of hosts in bridge for interface client data from Mikrotik"""
data = self.api.path("/interface/bridge/host", return_list=True) data = self.api.path("/interface/bridge/host")
if not data: if not data:
return return
@ -437,7 +437,7 @@ class MikrotikControllerData:
"""Get NAT data from Mikrotik""" """Get NAT data from Mikrotik"""
self.data["nat"] = parse_api( self.data["nat"] = parse_api(
data=self.data["nat"], data=self.data["nat"],
source=self.api.path("/ip/firewall/nat", return_list=True), source=self.api.path("/ip/firewall/nat"),
key=".id", key=".id",
vals=[ vals=[
{"name": ".id"}, {"name": ".id"},
@ -473,7 +473,7 @@ class MikrotikControllerData:
"""Get routerboard data from Mikrotik""" """Get routerboard data from Mikrotik"""
self.data["routerboard"] = parse_api( self.data["routerboard"] = parse_api(
data=self.data["routerboard"], data=self.data["routerboard"],
source=self.api.path("/system/routerboard", return_list=True), source=self.api.path("/system/routerboard"),
vals=[ vals=[
{"name": "routerboard", "type": "bool"}, {"name": "routerboard", "type": "bool"},
{"name": "model", "default": "unknown"}, {"name": "model", "default": "unknown"},
@ -489,7 +489,7 @@ class MikrotikControllerData:
"""Get system resources data from Mikrotik""" """Get system resources data from Mikrotik"""
self.data["resource"] = parse_api( self.data["resource"] = parse_api(
data=self.data["resource"], data=self.data["resource"],
source=self.api.path("/system/resource", return_list=True), source=self.api.path("/system/resource"),
vals=[ vals=[
{"name": "platform", "default": "unknown"}, {"name": "platform", "default": "unknown"},
{"name": "board-name", "default": "unknown"}, {"name": "board-name", "default": "unknown"},
@ -538,7 +538,7 @@ class MikrotikControllerData:
"""Check for firmware update on Mikrotik""" """Check for firmware update on Mikrotik"""
self.data["fw-update"] = parse_api( self.data["fw-update"] = parse_api(
data=self.data["fw-update"], data=self.data["fw-update"],
source=self.api.path("/system/package/update", return_list=True), source=self.api.path("/system/package/update"),
vals=[ vals=[
{"name": "status"}, {"name": "status"},
{"name": "channel", "default": "unknown"}, {"name": "channel", "default": "unknown"},
@ -563,7 +563,7 @@ class MikrotikControllerData:
"""Get list of all scripts from Mikrotik""" """Get list of all scripts from Mikrotik"""
self.data["script"] = parse_api( self.data["script"] = parse_api(
data=self.data["script"], data=self.data["script"],
source=self.api.path("/system/script", return_list=True), source=self.api.path("/system/script"),
key="name", key="name",
vals=[ vals=[
{"name": "name"}, {"name": "name"},
@ -580,7 +580,7 @@ class MikrotikControllerData:
"""Get Queue data from Mikrotik""" """Get Queue data from Mikrotik"""
self.data["queue"] = parse_api( self.data["queue"] = parse_api(
data=self.data["queue"], data=self.data["queue"],
source=self.api.path("/queue/simple", return_list=True), source=self.api.path("/queue/simple"),
key="name", key="name",
vals=[ vals=[
{"name": ".id"}, {"name": ".id"},

View file

@ -167,7 +167,7 @@ class MikrotikAPI:
# --------------------------- # ---------------------------
# path # path
# --------------------------- # ---------------------------
def path(self, path, return_list=False) -> Optional(list): def path(self, path, return_list=True) -> Optional(list):
"""Retrieve data from Mikrotik API.""" """Retrieve data from Mikrotik API."""
"""Returns generator object, unless return_list passed as True""" """Returns generator object, unless return_list passed as True"""
if not self._connected or not self._connection: if not self._connected or not self._connection:
@ -251,7 +251,7 @@ class MikrotikAPI:
if not self.connect(): if not self.connect():
return False return False
response = self.path(path) response = self.path(path, return_list=False)
if response is None: if response is None:
return False return False
@ -328,7 +328,7 @@ class MikrotikAPI:
if not self.connect(): if not self.connect():
return False return False
response = self.path("/system/script") response = self.path("/system/script", return_list=False)
if response is None: if response is None:
return False return False
@ -404,7 +404,7 @@ class MikrotikAPI:
if not self.connect(): if not self.connect():
return None return None
response = self.path("/interface") response = self.path("/interface", return_list=False)
if response is None: if response is None:
return None return None