kuon.watcher.adapters.models.sold_history.SoldHistory.__init__() - Code Metrics - Inspection of "[TASK] add return types for example usage" - DaRealFreak/Kuon - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7f328c...e44757 )

by Steffen

created 2018-09-12 13:45 UTC

SoldHistory.init() A

↳ Parent: kuon.watcher.adapters.models.sold_history

Complexity

Conditions

Size

Total Lines	12
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	4.048

Importance

Changes

Metric	Value
eloc	5
dl	0
loc	12
ccs	1
cts	5
cp	0.2
rs	10
c	0
b	0
f	0
cc	2
nop	3
crap	4.048

#!/usr/bin/python
# -*- coding: utf-8 -*-

from typing import List

from kuon.watcher.adapters.models import AbstractEntity
from kuon.watcher.adapters.models.sold_item import SoldItem


class SoldHistory(AbstractEntity):
    """General Sold History Response from the APIs"""

    def __init__(self, success: bool, sold_items: List[SoldItem] = None) -> None:
        """Initializing function

        :type success: bool
        :type sold_items: List[SoldItem]
        """
        self._success = success

        if sold_items:
            self._sold_items = sold_items
        else:
            self._sold_items = []

    @property
    def value(self) -> dict:
        """Return all important information from the API response like success and sold items

        :return:
        """
        return {
            'data': {
                'success': self._success,
                'sales': self.sold_items
            }
        }

    @property
    def sold_items(self) -> list:
        """Property for sold items which returns __dict__ of the sold item objects
        to allow JSON dump the search response without custom JSONEncoder objects

        :return:
        """
        return [i.__dict__ for i in self._sold_items]

    @sold_items.setter
    def sold_items(self, sold_items: List[SoldItem]) -> None:
        """Setter for sold items

        :type sold_items: List[SoldItem]
        :return:
        """
        self._sold_items = sold_items

    def add_sale(self, sold_item: SoldItem) -> None:
        """Adder for sold items

        :type sold_item: SoldItem
        :return:
        """
        if sold_item not in self._sold_items:
            self._sold_items.append(sold_item)


1		#!/usr/bin/python
2		# -- coding: utf-8 --
3
4	1	from typing import List
5
6	1	from kuon.watcher.adapters.models import AbstractEntity
7	1	from kuon.watcher.adapters.models.sold_item import SoldItem
8
9
10	1	class SoldHistory(AbstractEntity):
11		"""General Sold History Response from the APIs"""
12
13	1	def __init__(self, success: bool, sold_items: List[SoldItem] = None) -> None:
14		"""Initializing function
15
16		:type success: bool
17		:type sold_items: List[SoldItem]
18		"""
19		self._success = success
20
21		if sold_items:
22		self._sold_items = sold_items
23		else:
24		self._sold_items = []
25
26	1	@property
27	1	def value(self) -> dict:
28		"""Return all important information from the API response like success and sold items
29
30		:return:
31		"""
32		return {
33		'data': {
34		'success': self._success,
35		'sales': self.sold_items
36		}
37		}
38
39	1	@property
40	1	def sold_items(self) -> list:
41		"""Property for sold items which returns __dict__ of the sold item objects
42		to allow JSON dump the search response without custom JSONEncoder objects
43
44		:return:
45		"""
46		return [i.__dict__ for i in self._sold_items]
47
48	1	@sold_items.setter
49	1	def sold_items(self, sold_items: List[SoldItem]) -> None:
50		"""Setter for sold items
51
52		:type sold_items: List[SoldItem]
53		:return:
54		"""
55		self._sold_items = sold_items
56
57	1	def add_sale(self, sold_item: SoldItem) -> None:
58		"""Adder for sold items
59
60		:type sold_item: SoldItem
61		:return:
62		"""
63		if sold_item not in self._sold_items:
64		self._sold_items.append(sold_item)
65

DaRealFreak / Kuon

Push — master ( 7f328c...e44757 )

SoldHistory.__init__() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

SoldHistory.init() A