tcllib.requests.checkrequest.CheckRequest.get_headers() - Code Metrics - Inspection of "Merge branch 'rewrite'" - mbirth/tcl_ota_check - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2adcb6...75d235 )

by Markus

created 2018-02-11 00:53 UTC

CheckRequest.get_headers() A

↳ Parent: tcllib.requests.checkrequest

Complexity

Conditions

Size

Total Lines	2
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	2
dl	0
loc	2
rs	10
c	0
b	0
f	0
cc	1
nop	1

# -*- coding: utf-8 -*-
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

from collections import OrderedDict
from .. import devices
from .tclrequest import TclRequest
from .tclresult import CheckResult

class CheckRequest(TclRequest):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    def __init__(self, device: devices.Device):

        super().__init__()
        self.uri = "/check.php"
        self.method = "GET"
        self.device = device
    

    def get_headers(self):
        return {"User-Agent": self.device.ua}

    def get_params(self):
        params = OrderedDict()
        params["id"] = self.device.imei
        params["curef"] = self.device.curef
        params["fv"] = self.device.fwver
        params["mode"] = self.device.mode
        params["type"] = self.device.type
        params["cltp"] = self.device.cltp
        params["cktp"] = self.device.cktp
        params["rtd"] = self.device.rtd
        params["chnl"] = self.device.chnl
        #params["osvs"] = self.device.osvs
        #params["ckot"] = self.device.ckot
        return params

    def is_done(self, http_status: int, contents: str) -> bool:
        ok_states = {
            204: "No update available.",
            404: "No data for requested CUREF/FV combination.",
        }
        if http_status == 200:
            self.response = contents
            self.result = CheckResult(contents)
            self.success = True
            return True
        elif http_status in ok_states:
            self.error = ok_states[http_status]
            self.success = False
            return True
        elif http_status not in [500, 502, 503]:
            # Errors OTHER than 500, 502 or 503 are probably
            # errors where we don't need to retry
            self.error ="HTTP {}.".format(http_status)

            self.success = False
            return True
        return False

# Check requests have 4 possible outcomes:
# 1. HTTP 200 with XML data - our desired info
# 2. HTTP 204 - means: no newer update available
# 3. HTTP 404 - means: invalid device or firmware version
# 4. anything else: server problem (esp. 500, 502, 503)


1			# -- coding: utf-8 --
			0 ignored issues – show Coding Style introduced 2018-02-11 00:55 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
2
3			from collections import OrderedDict
4			from .. import devices
5			from .tclrequest import TclRequest
6			from .tclresult import CheckResult
7
8			class CheckRequest(TclRequest):
			0 ignored issues – show Coding Style introduced 2018-02-11 00:55 UTC by Report Bug Copy Issue Report This class should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history... Unused Code introduced 2018-02-11 00:55 UTC by Report Bug Copy Issue Report The variable `__class__` seems to be unused. Loading history...
9			def __init__(self, device: devices.Device):
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-02-11 00:55 UTC by Report Bug Copy Issue Report The variable `devices` does not seem to be defined. Loading history...
10			super().__init__()
11			self.uri = "/check.php"
12			self.method = "GET"
13			self.device = device
14
			0 ignored issues – show Coding Style introduced 2018-02-11 00:55 UTC by Report Bug Copy Issue Report Trailing whitespace Loading history...
15			def get_headers(self):
16			return {"User-Agent": self.device.ua}
17
18			def get_params(self):
19			params = OrderedDict()
20			params["id"] = self.device.imei
21			params["curef"] = self.device.curef
22			params["fv"] = self.device.fwver
23			params["mode"] = self.device.mode
24			params["type"] = self.device.type
25			params["cltp"] = self.device.cltp
26			params["cktp"] = self.device.cktp
27			params["rtd"] = self.device.rtd
28			params["chnl"] = self.device.chnl
29			#params["osvs"] = self.device.osvs
30			#params["ckot"] = self.device.ckot
31			return params
32
33			def is_done(self, http_status: int, contents: str) -> bool:
34			ok_states = {
35			204: "No update available.",
36			404: "No data for requested CUREF/FV combination.",
37			}
38			if http_status == 200:
39			self.response = contents
40			self.result = CheckResult(contents)
41			self.success = True
42			return True
43			elif http_status in ok_states:
44			self.error = ok_states[http_status]
45			self.success = False
46			return True
47			elif http_status not in [500, 502, 503]:
48			# Errors OTHER than 500, 502 or 503 are probably
49			# errors where we don't need to retry
50			self.error ="HTTP {}.".format(http_status)
			0 ignored issues – show Coding Style introduced 2018-02-11 00:55 UTC by Report Bug Copy Issue Report Exactly one space required after assignment Loading history...
51			self.success = False
52			return True
53			return False
54
55			# Check requests have 4 possible outcomes:
56			# 1. HTTP 200 with XML data - our desired info
57			# 2. HTTP 204 - means: no newer update available
58			# 3. HTTP 404 - means: invalid device or firmware version
59			# 4. anything else: server problem (esp. 500, 502, 503)
60

mbirth / tcl_ota_check

Push — master ( 2adcb6...75d235 )

CheckRequest.get_headers() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like