tcllib.devlist.get_devicelist() - Code Metrics - Inspection of "More trying to please Scrutinizer." - mbirth/tcl_ota_check - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1707bc...16d33b )

by Markus

created 2018-02-14 23:39 UTC

tcllib.devlist.get_devicelist() A

↳ Parent: tcllib.devlist

Complexity

Conditions

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	6
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	2
nop	3

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# pylint: disable=C0111,C0326,C0103

"""Tools to manage saved device databases."""

import json
import os
import time

import requests

from . import ansi


DEVICELIST_URL = "https://tclota.birth-online.de/json_lastupdates.php"
DEVICELIST_FILE = "prds.json"
DEVICELIST_CACHE_SECONDS = 86400


def _load_local_devicelist():
    """Load local devicelist and return decoded JSON (or None) and need_download status."""
    need_download = True
    try:
        filestat = os.stat(DEVICELIST_FILE)
        filemtime = filestat.st_mtime
        if filemtime > time.time() - DEVICELIST_CACHE_SECONDS:
            need_download = False
        with open(DEVICELIST_FILE, "rt") as dlfile:
            return json.load(dlfile), need_download
    except FileNotFoundError:
        return None, True

def _download_devicelist(doit: bool):
    """Download device list if doit is set. Or do nothing."""
    if doit:
        prds_json = requests.get(DEVICELIST_URL).text
        with open(DEVICELIST_FILE, "wt") as dlfile:
            dlfile.write(prds_json)

def _load_devicelist_with_diff(output_diff: bool, old_prds: dict = {}) -> dict:
# Bad:
# If array_param is modified inside the function, the next invocation will
# receive the modified object.
def some_function(array_param=[]):
    # ...

# Better: Create an array on each invocation
def some_function(array_param=None):
    array_param = array_param or []
    # ...
    """Load local devicelist and output diff if requested."""
    with open(DEVICELIST_FILE, "rt") as dlfile:
        prds = json.load(dlfile)

    if old_prds and output_diff:
        print_prd_diff(old_prds, prds)

    return prds

def get_devicelist(force: bool=False, output_diff: bool=True, local: bool=False) -> dict:
    """Return device list from saved database."""
    old_prds, need_download = _load_local_devicelist()

    if local:
        return old_prds

    _download_devicelist(need_download or force)

    return _load_devicelist_with_diff(output_diff, old_prds)


def print_versions_diff(old_data: dict, new_data: dict):
    """Print version changes between old and new databases."""
    prd = new_data["curef"]
    if new_data["last_full"] != old_data["last_full"] and new_data["last_ota"] != old_data["last_ota"]:
        print("> {}: {} ⇨ {} (OTA: {} ⇨ {})".format(
            prd,
            ansi.CYAN_DARK + str(old_data["last_full"]) + ansi.RESET,
            ansi.CYAN + str(new_data["last_full"]) + ansi.RESET,
            ansi.YELLOW_DARK + str(old_data["last_ota"]) + ansi.RESET,
            ansi.YELLOW + str(new_data["last_ota"]) + ansi.RESET
        ))
    elif new_data["last_full"] != old_data["last_full"]:
        print("> {}: {} ⇨ {} (FULL)".format(prd, ansi.CYAN_DARK + str(old_data["last_full"]) + ansi.RESET, ansi.CYAN + str(new_data["last_full"]) + ansi.RESET))
    elif new_data["last_ota"] != old_data["last_ota"]:
        print("> {}: {} ⇨ {} (OTA)".format(prd, ansi.YELLOW_DARK + str(old_data["last_ota"]) + ansi.RESET, ansi.YELLOW + str(new_data["last_ota"]) + ansi.RESET))

def _print_removed_prds(prds_data: dict, removed_prds: list):
    """Print details of selected PRDs as removed."""
    for prd in removed_prds:
        print("> Removed device {} (was at {} / OTA: {}).".format(ansi.RED + prd + ansi.RESET, prds_data[prd]["last_full"], prds_data[prd]["last_ota"]))

def _print_added_prds(prds_data: dict, added_prds: list):
    """Print details of selected PRDs as added."""
    for prd in added_prds:
        print("> New device {} ({} / OTA: {}).".format(ansi.GREEN + prd + ansi.RESET, prds_data[prd]["last_full"], prds_data[prd]["last_ota"]))

def _print_changed_prds(old_prds: dict, new_prds: dict, skip_prds: list):
    """Print details of changed PRDs."""
    for prd, pdata in new_prds.items():
        if prd in skip_prds:
            continue
        odata = old_prds[prd]
        print_versions_diff(odata, pdata)

def print_prd_diff(old_prds: dict, new_prds: dict):
    """Print PRD changes between old and new databases."""
    added_prds = [prd for prd in new_prds if prd not in old_prds]
    removed_prds = [prd for prd in old_prds if prd not in new_prds]
    _print_removed_prds(old_prds, removed_prds)
    _print_added_prds(new_prds, added_prds)
    _print_changed_prds(old_prds, new_prds, added_prds)


1			#!/usr/bin/env python3
2			# -- coding: utf-8 --
3
4			# pylint: disable=C0111,C0326,C0103
5
6			"""Tools to manage saved device databases."""
7
8			import json
9			import os
10			import time
11
12			import requests
13
14			from . import ansi
15
16
17			DEVICELIST_URL = "https://tclota.birth-online.de/json_lastupdates.php"
18			DEVICELIST_FILE = "prds.json"
19			DEVICELIST_CACHE_SECONDS = 86400
20
21
22			def _load_local_devicelist():
23			"""Load local devicelist and return decoded JSON (or None) and need_download status."""
24			need_download = True
25			try:
26			filestat = os.stat(DEVICELIST_FILE)
27			filemtime = filestat.st_mtime
28			if filemtime > time.time() - DEVICELIST_CACHE_SECONDS:
29			need_download = False
30			with open(DEVICELIST_FILE, "rt") as dlfile:
31			return json.load(dlfile), need_download
32			except FileNotFoundError:
33			return None, True
34
35			def _download_devicelist(doit: bool):
36			"""Download device list if doit is set. Or do nothing."""
37			if doit:
38			prds_json = requests.get(DEVICELIST_URL).text
39			with open(DEVICELIST_FILE, "wt") as dlfile:
40			dlfile.write(prds_json)
41
42			def _load_devicelist_with_diff(output_diff: bool, old_prds: dict = {}) -> dict:
			0 ignored issues – show Bug Best Practice introduced 2018-02-14 23:41 UTC by Report Bug Copy Issue Report The default value `{}` might cause unintended side-effects. Objects as default values are only created once in Python and not on each invocation of the function. If the default object is modified, this modification is carried over to the next invocation of the method. # Bad: # If array_param is modified inside the function, the next invocation will # receive the modified object. def some_function(array_param=[]): # ... # Better: Create an array on each invocation def some_function(array_param=None): array_param = array_param or [] # ... Loading history...
43			"""Load local devicelist and output diff if requested."""
44			with open(DEVICELIST_FILE, "rt") as dlfile:
45			prds = json.load(dlfile)
46
47			if old_prds and output_diff:
48			print_prd_diff(old_prds, prds)
49
50			return prds
51
52			def get_devicelist(force: bool=False, output_diff: bool=True, local: bool=False) -> dict:
53			"""Return device list from saved database."""
54			old_prds, need_download = _load_local_devicelist()
55
56			if local:
57			return old_prds
58
59			_download_devicelist(need_download or force)
60
61			return _load_devicelist_with_diff(output_diff, old_prds)
62
63
64			def print_versions_diff(old_data: dict, new_data: dict):
65			"""Print version changes between old and new databases."""
66			prd = new_data["curef"]
67			if new_data["last_full"] != old_data["last_full"] and new_data["last_ota"] != old_data["last_ota"]:
68			print("> {}: {} ⇨ {} (OTA: {} ⇨ {})".format(
69			prd,
70			ansi.CYAN_DARK + str(old_data["last_full"]) + ansi.RESET,
71			ansi.CYAN + str(new_data["last_full"]) + ansi.RESET,
72			ansi.YELLOW_DARK + str(old_data["last_ota"]) + ansi.RESET,
73			ansi.YELLOW + str(new_data["last_ota"]) + ansi.RESET
74			))
75			elif new_data["last_full"] != old_data["last_full"]:
76			print("> {}: {} ⇨ {} (FULL)".format(prd, ansi.CYAN_DARK + str(old_data["last_full"]) + ansi.RESET, ansi.CYAN + str(new_data["last_full"]) + ansi.RESET))
77			elif new_data["last_ota"] != old_data["last_ota"]:
78			print("> {}: {} ⇨ {} (OTA)".format(prd, ansi.YELLOW_DARK + str(old_data["last_ota"]) + ansi.RESET, ansi.YELLOW + str(new_data["last_ota"]) + ansi.RESET))
79
80			def _print_removed_prds(prds_data: dict, removed_prds: list):
81			"""Print details of selected PRDs as removed."""
82			for prd in removed_prds:
83			print("> Removed device {} (was at {} / OTA: {}).".format(ansi.RED + prd + ansi.RESET, prds_data[prd]["last_full"], prds_data[prd]["last_ota"]))
84
85			def _print_added_prds(prds_data: dict, added_prds: list):
86			"""Print details of selected PRDs as added."""
87			for prd in added_prds:
88			print("> New device {} ({} / OTA: {}).".format(ansi.GREEN + prd + ansi.RESET, prds_data[prd]["last_full"], prds_data[prd]["last_ota"]))
89
90			def _print_changed_prds(old_prds: dict, new_prds: dict, skip_prds: list):
91			"""Print details of changed PRDs."""
92			for prd, pdata in new_prds.items():
93			if prd in skip_prds:
94			continue
95			odata = old_prds[prd]
96			print_versions_diff(odata, pdata)
97
98			def print_prd_diff(old_prds: dict, new_prds: dict):
99			"""Print PRD changes between old and new databases."""
100			added_prds = [prd for prd in new_prds if prd not in old_prds]
101			removed_prds = [prd for prd in old_prds if prd not in new_prds]
102			_print_removed_prds(old_prds, removed_prds)
103			_print_added_prds(new_prds, added_prds)
104			_print_changed_prds(old_prds, new_prds, added_prds)
105

mbirth / tcl_ota_check

Push — master ( 1707bc...16d33b )

tcllib.devlist.get_devicelist() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like