reformatted code using black

This commit is contained in:
tomaae 2020-03-16 04:51:41 +01:00
parent cd4d7c4e81
commit e418c20252
8 changed files with 512 additions and 322 deletions

View file

@ -26,31 +26,48 @@ _LOGGER = logging.getLogger(__name__)
# ---------------------------
# MikrotikControllerData
# ---------------------------
class MikrotikControllerData():
class MikrotikControllerData:
"""MikrotikController Class"""
def __init__(self, hass, config_entry, name, host, port, username, password, use_ssl, traffic_type):
def __init__(
self,
hass,
config_entry,
name,
host,
port,
username,
password,
use_ssl,
traffic_type,
):
"""Initialize MikrotikController."""
self.name = name
self.hass = hass
self.config_entry = config_entry
self.traffic_type = traffic_type
self.data = {'routerboard': {},
'resource': {},
'interface': {},
'arp': {},
'nat': {},
'fw-update': {},
'script': {}
}
self.data = {
"routerboard": {},
"resource": {},
"interface": {},
"arp": {},
"nat": {},
"fw-update": {},
"script": {},
}
self.listeners = []
self.lock = asyncio.Lock()
self.api = MikrotikAPI(host, username, password, port, use_ssl)
async_track_time_interval(self.hass, self.force_update, self.option_scan_interval)
async_track_time_interval(self.hass, self.force_fwupdate_check, timedelta(hours=1))
async_track_time_interval(
self.hass, self.force_update, self.option_scan_interval
)
async_track_time_interval(
self.hass, self.force_fwupdate_check, timedelta(hours=1)
)
# ---------------------------
# force_update
@ -80,7 +97,9 @@ class MikrotikControllerData():
@property
def option_scan_interval(self):
"""Config entry option scan interval."""
scan_interval = self.config_entry.options.get(CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL)
scan_interval = self.config_entry.options.get(
CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL
)
return timedelta(seconds=scan_interval)
# ---------------------------
@ -89,7 +108,9 @@ class MikrotikControllerData():
@property
def option_traffic_type(self):
"""Config entry option to not track ARP."""
return self.config_entry.options.get(CONF_UNIT_OF_MEASUREMENT, DEFAULT_TRAFFIC_TYPE)
return self.config_entry.options.get(
CONF_UNIT_OF_MEASUREMENT, DEFAULT_TRAFFIC_TYPE
)
# ---------------------------
# signal_update
@ -138,7 +159,7 @@ class MikrotikControllerData():
except:
return
if 'available' not in self.data['fw-update']:
if "available" not in self.data["fw-update"]:
await self.async_fwupdate_check()
await self.hass.async_add_executor_job(self.get_interface)
@ -184,30 +205,35 @@ class MikrotikControllerData():
# ---------------------------
def get_interface(self):
"""Get all interfaces data from Mikrotik"""
self.data['interface'] = parse_api(
data=self.data['interface'],
self.data["interface"] = parse_api(
data=self.data["interface"],
source=self.api.path("/interface"),
key='default-name',
key="default-name",
vals=[
{'name': 'default-name'},
{'name': 'name', 'default_val': 'default-name'},
{'name': 'type', 'default': 'unknown'},
{'name': 'running', 'type': 'bool'},
{'name': 'enabled', 'source': 'disabled', 'type': 'bool', 'reverse': True},
{'name': 'port-mac-address', 'source': 'mac-address'},
{'name': 'comment'},
{'name': 'last-link-down-time'},
{'name': 'last-link-up-time'},
{'name': 'link-downs'},
{'name': 'tx-queue-drop'},
{'name': 'actual-mtu'}
{"name": "default-name"},
{"name": "name", "default_val": "default-name"},
{"name": "type", "default": "unknown"},
{"name": "running", "type": "bool"},
{
"name": "enabled",
"source": "disabled",
"type": "bool",
"reverse": True,
},
{"name": "port-mac-address", "source": "mac-address"},
{"name": "comment"},
{"name": "last-link-down-time"},
{"name": "last-link-up-time"},
{"name": "link-downs"},
{"name": "tx-queue-drop"},
{"name": "actual-mtu"},
],
ensure_vals=[
{'name': 'client-ip-address'},
{'name': 'client-mac-address'},
{'name': 'rx-bits-per-second', 'default': 0},
{'name': 'tx-bits-per-second', 'default': 0}
]
{"name": "client-ip-address"},
{"name": "client-mac-address"},
{"name": "rx-bits-per-second", "default": 0},
{"name": "tx-bits-per-second", "default": 0},
],
)
# ---------------------------
@ -216,19 +242,19 @@ class MikrotikControllerData():
def get_interface_traffic(self):
"""Get traffic for all interfaces from Mikrotik"""
interface_list = ""
for uid in self.data['interface']:
interface_list += self.data['interface'][uid]['name'] + ","
for uid in self.data["interface"]:
interface_list += self.data["interface"][uid]["name"] + ","
interface_list = interface_list[:-1]
self.data['interface'] = parse_api(
data=self.data['interface'],
self.data["interface"] = parse_api(
data=self.data["interface"],
source=self.api.get_traffic(interface_list),
key_search='name',
key_search="name",
vals=[
{'name': 'rx-bits-per-second', 'default': 0},
{'name': 'tx-bits-per-second', 'default': 0},
]
{"name": "rx-bits-per-second", "default": 0},
{"name": "tx-bits-per-second", "default": 0},
],
)
traffic_type = self.option_traffic_type
@ -239,26 +265,28 @@ class MikrotikControllerData():
elif traffic_type == "mbps":
traffic_div = 1000000
for uid in self.data['interface']:
self.data['interface'][uid]['rx-bits-per-second-attr'] = traffic_type
self.data['interface'][uid]['tx-bits-per-second-attr'] = traffic_type
self.data['interface'][uid]['rx-bits-per-second'] = round(
self.data['interface'][uid]['rx-bits-per-second'] / traffic_div)
self.data['interface'][uid]['tx-bits-per-second'] = round(
self.data['interface'][uid]['tx-bits-per-second'] / traffic_div)
for uid in self.data["interface"]:
self.data["interface"][uid]["rx-bits-per-second-attr"] = traffic_type
self.data["interface"][uid]["tx-bits-per-second-attr"] = traffic_type
self.data["interface"][uid]["rx-bits-per-second"] = round(
self.data["interface"][uid]["rx-bits-per-second"] / traffic_div
)
self.data["interface"][uid]["tx-bits-per-second"] = round(
self.data["interface"][uid]["tx-bits-per-second"] / traffic_div
)
# ---------------------------
# get_interface_client
# ---------------------------
def get_interface_client(self):
"""Get ARP data from Mikrotik"""
self.data['arp'] = {}
self.data["arp"] = {}
# Remove data if disabled
if not self.option_track_arp:
for uid in self.data['interface']:
self.data['interface'][uid]['client-ip-address'] = "disabled"
self.data['interface'][uid]['client-mac-address'] = "disabled"
for uid in self.data["interface"]:
self.data["interface"][uid]["client-ip-address"] = "disabled"
self.data["interface"][uid]["client-mac-address"] = "disabled"
return
mac2ip = {}
@ -269,12 +297,16 @@ class MikrotikControllerData():
self.update_bridge_hosts(mac2ip)
# Map ARP to ifaces
for uid in self.data['interface']:
if uid not in self.data['arp']:
for uid in self.data["interface"]:
if uid not in self.data["arp"]:
continue
self.data['interface'][uid]['client-ip-address'] = from_entry(self.data['arp'][uid], 'address')
self.data['interface'][uid]['client-mac-address'] = from_entry(self.data['arp'][uid], 'mac-address')
self.data["interface"][uid]["client-ip-address"] = from_entry(
self.data["arp"][uid], "address"
)
self.data["interface"][uid]["client-mac-address"] = from_entry(
self.data["arp"][uid], "mac-address"
)
# ---------------------------
# update_arp
@ -287,18 +319,18 @@ class MikrotikControllerData():
for entry in data:
# Ignore invalid entries
if entry['invalid']:
if entry["invalid"]:
continue
if 'interface' not in entry:
if "interface" not in entry:
continue
# Do not add ARP detected on bridge
if entry['interface'] == "bridge":
if entry["interface"] == "bridge":
bridge_used = True
# Build address table on bridge
if 'mac-address' in entry and 'address' in entry:
mac2ip[entry['mac-address']] = entry['address']
if "mac-address" in entry and "address" in entry:
mac2ip[entry["mac-address"]] = entry["address"]
continue
@ -309,13 +341,21 @@ class MikrotikControllerData():
_LOGGER.debug("Processing entry %s, entry %s", "/ip/arp", entry)
# Create uid arp dict
if uid not in self.data['arp']:
self.data['arp'][uid] = {}
if uid not in self.data["arp"]:
self.data["arp"][uid] = {}
# Add data
self.data['arp'][uid]['interface'] = uid
self.data['arp'][uid]['mac-address'] = from_entry(entry, 'mac-address') if 'mac-address' not in self.data['arp'][uid] else "multiple"
self.data['arp'][uid]['address'] = from_entry(entry, 'address') if 'address' not in self.data['arp'][uid] else "multiple"
self.data["arp"][uid]["interface"] = uid
self.data["arp"][uid]["mac-address"] = (
from_entry(entry, "mac-address")
if "mac-address" not in self.data["arp"][uid]
else "multiple"
)
self.data["arp"][uid]["address"] = (
from_entry(entry, "address")
if "address" not in self.data["arp"][uid]
else "multiple"
)
return mac2ip, bridge_used
@ -330,7 +370,7 @@ class MikrotikControllerData():
for entry in data:
# Ignore port MAC
if entry['local']:
if entry["local"]:
continue
# Get iface default-name from custom name
@ -338,19 +378,25 @@ class MikrotikControllerData():
if not uid:
continue
_LOGGER.debug("Processing entry %s, entry %s", "/interface/bridge/host", entry)
_LOGGER.debug(
"Processing entry %s, entry %s", "/interface/bridge/host", entry
)
# Create uid arp dict
if uid not in self.data['arp']:
self.data['arp'][uid] = {}
if uid not in self.data["arp"]:
self.data["arp"][uid] = {}
# Add data
self.data['arp'][uid]['interface'] = uid
if 'mac-address' in self.data['arp'][uid]:
self.data['arp'][uid]['mac-address'] = "multiple"
self.data['arp'][uid]['address'] = "multiple"
self.data["arp"][uid]["interface"] = uid
if "mac-address" in self.data["arp"][uid]:
self.data["arp"][uid]["mac-address"] = "multiple"
self.data["arp"][uid]["address"] = "multiple"
else:
self.data['arp'][uid]['mac-address'] = from_entry(entry, 'mac-address')
self.data['arp'][uid]['address'] = mac2ip[self.data['arp'][uid]['mac-address']] if self.data['arp'][uid]['mac-address'] in mac2ip else ""
self.data["arp"][uid]["mac-address"] = from_entry(entry, "mac-address")
self.data["arp"][uid]["address"] = (
mac2ip[self.data["arp"][uid]["mac-address"]]
if self.data["arp"][uid]["mac-address"] in mac2ip
else ""
)
# ---------------------------
# get_iface_from_entry
@ -358,8 +404,8 @@ class MikrotikControllerData():
def get_iface_from_entry(self, entry):
"""Get interface default-name using name from interface dict"""
uid = None
for ifacename in self.data['interface']:
if self.data['interface'][ifacename]['name'] == entry['interface']:
for ifacename in self.data["interface"]:
if self.data["interface"][ifacename]["name"] == entry["interface"]:
uid = ifacename
break
@ -370,32 +416,35 @@ class MikrotikControllerData():
# ---------------------------
def get_nat(self):
"""Get NAT data from Mikrotik"""
self.data['nat'] = parse_api(
data=self.data['nat'],
self.data["nat"] = parse_api(
data=self.data["nat"],
source=self.api.path("/ip/firewall/nat"),
key='.id',
key=".id",
vals=[
{'name': '.id'},
{'name': 'protocol', 'default': 'any'},
{'name': 'dst-port', 'default': 'any'},
{'name': 'in-interface', 'default': 'any'},
{'name': 'to-addresses'},
{'name': 'to-ports'},
{'name': 'comment'},
{'name': 'enabled', 'source': 'disabled', 'type': 'bool', 'reverse': True}
{"name": ".id"},
{"name": "protocol", "default": "any"},
{"name": "dst-port", "default": "any"},
{"name": "in-interface", "default": "any"},
{"name": "to-addresses"},
{"name": "to-ports"},
{"name": "comment"},
{
"name": "enabled",
"source": "disabled",
"type": "bool",
"reverse": True,
},
],
val_proc=[
[
{'name': 'name'},
{'action': 'combine'},
{'key': 'protocol'},
{'text': ':'},
{'key': 'dst-port'}
{"name": "name"},
{"action": "combine"},
{"key": "protocol"},
{"text": ":"},
{"key": "dst-port"},
]
],
only=[
{'key': 'action', 'value': 'dst-nat'}
]
only=[{"key": "action", "value": "dst-nat"}],
)
# ---------------------------
@ -403,15 +452,15 @@ class MikrotikControllerData():
# ---------------------------
def get_system_routerboard(self):
"""Get routerboard data from Mikrotik"""
self.data['routerboard'] = parse_api(
data=self.data['routerboard'],
self.data["routerboard"] = parse_api(
data=self.data["routerboard"],
source=self.api.path("/system/routerboard"),
vals=[
{'name': 'routerboard', 'type': 'bool'},
{'name': 'model', 'default': 'unknown'},
{'name': 'serial-number', 'default': 'unknown'},
{'name': 'firmware', 'default': 'unknown'}
]
{"name": "routerboard", "type": "bool"},
{"name": "model", "default": "unknown"},
{"name": "serial-number", "default": "unknown"},
{"name": "firmware", "default": "unknown"},
],
)
# ---------------------------
@ -419,65 +468,87 @@ class MikrotikControllerData():
# ---------------------------
def get_system_resource(self):
"""Get system resources data from Mikrotik"""
self.data['resource'] = parse_api(
data=self.data['resource'],
self.data["resource"] = parse_api(
data=self.data["resource"],
source=self.api.path("/system/resource"),
vals=[
{'name': 'platform', 'default': 'unknown'},
{'name': 'board-name', 'default': 'unknown'},
{'name': 'version', 'default': 'unknown'},
{'name': 'uptime', 'default': 'unknown'},
{'name': 'cpu-load', 'default': 'unknown'},
{'name': 'free-memory', 'default': 0},
{'name': 'total-memory', 'default': 0},
{'name': 'free-hdd-space', 'default': 0},
{'name': 'total-hdd-space', 'default': 0}
]
{"name": "platform", "default": "unknown"},
{"name": "board-name", "default": "unknown"},
{"name": "version", "default": "unknown"},
{"name": "uptime", "default": "unknown"},
{"name": "cpu-load", "default": "unknown"},
{"name": "free-memory", "default": 0},
{"name": "total-memory", "default": 0},
{"name": "free-hdd-space", "default": 0},
{"name": "total-hdd-space", "default": 0},
],
)
if self.data['resource']['total-memory'] > 0:
self.data['resource']['memory-usage'] = round(((self.data['resource']['total-memory'] - self.data['resource']['free-memory']) / self.data['resource']['total-memory']) * 100)
if self.data["resource"]["total-memory"] > 0:
self.data["resource"]["memory-usage"] = round(
(
(
self.data["resource"]["total-memory"]
- self.data["resource"]["free-memory"]
)
/ self.data["resource"]["total-memory"]
)
* 100
)
else:
self.data['resource']['memory-usage'] = "unknown"
self.data["resource"]["memory-usage"] = "unknown"
if self.data['resource']['total-hdd-space'] > 0:
self.data['resource']['hdd-usage'] = round(((self.data['resource']['total-hdd-space'] - self.data['resource']['free-hdd-space']) / self.data['resource']['total-hdd-space']) * 100)
if self.data["resource"]["total-hdd-space"] > 0:
self.data["resource"]["hdd-usage"] = round(
(
(
self.data["resource"]["total-hdd-space"]
- self.data["resource"]["free-hdd-space"]
)
/ self.data["resource"]["total-hdd-space"]
)
* 100
)
else:
self.data['resource']['hdd-usage'] = "unknown"
self.data["resource"]["hdd-usage"] = "unknown"
# ---------------------------
# get_system_routerboard
# ---------------------------
def get_firmware_update(self):
"""Check for firmware update on Mikrotik"""
self.data['fw-update'] = parse_api(
data=self.data['fw-update'],
self.data["fw-update"] = parse_api(
data=self.data["fw-update"],
source=self.api.path("/system/package/update"),
vals=[
{'name': 'status'},
{'name': 'channel', 'default': 'unknown'},
{'name': 'installed-version', 'default': 'unknown'},
{'name': 'latest-version', 'default': 'unknown'}
]
{"name": "status"},
{"name": "channel", "default": "unknown"},
{"name": "installed-version", "default": "unknown"},
{"name": "latest-version", "default": "unknown"},
],
)
if 'status' in self.data['fw-update']:
self.data['fw-update']['available'] = True if self.data['fw-update']['status'] == "New version is available" else False
if "status" in self.data["fw-update"]:
self.data["fw-update"]["available"] = (
True
if self.data["fw-update"]["status"] == "New version is available"
else False
)
else:
self.data['fw-update']['available'] = False
self.data["fw-update"]["available"] = False
# ---------------------------
# get_script
# ---------------------------
def get_script(self):
"""Get list of all scripts from Mikrotik"""
self.data['script'] = parse_api(
data=self.data['script'],
self.data["script"] = parse_api(
data=self.data["script"],
source=self.api.path("/system/script"),
key='name',
key="name",
vals=[
{'name': 'name'},
{'name': 'last-started', 'default': 'unknown'},
{'name': 'run-count', 'default': 'unknown'}
]
{"name": "name"},
{"name": "last-started", "default": "unknown"},
{"name": "run-count", "default": "unknown"},
],
)