GetMessage.from_exception() - Code Metrics - Inspection of "Minor adjustment to the logging of API requests" - fuzeman/Plex-Trakt-Scrobbler - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( b44848...2798d2 )

by Dean

created 2016-12-22 03:20 UTC

GetMessage.from_exception() A

↳ Parent: GetMessage

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1.125

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	1
cts	2
cp	0.5
rs	9.4285
c	0
b	0
f	0
cc	1
crap	1.125

from plugin.core.constants import PLUGIN_VERSION_BASE, PLUGIN_VERSION_BRANCH
from plugin.managers.core.base import Get, Manager
from plugin.models import Message

from datetime import datetime
import logging

VERSION_BASE = '.'.join([str(x) for x in PLUGIN_VERSION_BASE])
VERSION_BRANCH = PLUGIN_VERSION_BRANCH

log = logging.getLogger(__name__)


class GetMessage(Get):
    def _log(self, message_type, *args, **kwargs):
        # Find matching (or create new dummy) error message
        message = self.or_create(
            Message.type == message_type,
            *args,

            type=message_type,
            last_logged_at=datetime.utcnow(),

            revision=0,

            version_base=VERSION_BASE,
            version_branch=VERSION_BRANCH,
            **kwargs
        )

        if message and not message._created:
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
            # Update summary/description
            if kwargs.get('summary'):
                message.summary = kwargs['summary']

            if kwargs.get('description'):
                message.description = kwargs['description']

            # Update `last_logged_at` timestamp
            message.last_logged_at = datetime.utcnow()

            # Update version details
            message.version_base = VERSION_BASE
            message.version_branch = VERSION_BRANCH

            # Save changes to message
            message.save()

        return message

    def from_exception(self, exception, message_type=Message.Type.Exception):
        # Log exception
        return self._log(
            message_type,

            # Query
            Message.exception_hash == exception.hash,

            # Parameters
            exception_hash=exception.hash,

            summary=exception.message,
            description=exception.traceback
        )

    def from_message(self, level, message, code=None, description=None):
        # Convert `level` to `Message.Type`
        if level == logging.INFO:
            type = Message.Type.Info

        elif level == logging.WARNING:
            type = Message.Type.Warning
        elif level == logging.ERROR:
            type = Message.Type.Error
        elif level == logging.CRITICAL:
            type = Message.Type.Critical
        else:
            raise ValueError('Unknown value for "level" parameter')

        # Log message
        return self._log(
            type,

            # Query
            Message.code == code,

            # Parameters
            code=code,

            summary=message,
            description=description
        )


class MessageManager(Manager):
    get = GetMessage

    model = Message


1	1	from plugin.core.constants import PLUGIN_VERSION_BASE, PLUGIN_VERSION_BRANCH
2	1	from plugin.managers.core.base import Get, Manager
3	1	from plugin.models import Message
4
5	1	from datetime import datetime
6	1	import logging
7
8	1	VERSION_BASE = '.'.join([str(x) for x in PLUGIN_VERSION_BASE])
9	1	VERSION_BRANCH = PLUGIN_VERSION_BRANCH
10
11	1	log = logging.getLogger(__name__)
12
13
14	1	class GetMessage(Get):
15	1	def _log(self, message_type, args, *kwargs):
16		# Find matching (or create new dummy) error message
17	1	message = self.or_create(
18		Message.type == message_type,
19		*args,
20
21		type=message_type,
22		last_logged_at=datetime.utcnow(),
23
24		revision=0,
25
26		version_base=VERSION_BASE,
27		version_branch=VERSION_BRANCH,
28		**kwargs
29		)
30
31	1	if message and not message._created:
		0 ignored issues – show Coding Style Best Practice introduced 2015-12-19 01:32 UTC by Report Bug Copy Issue Report It seems like `_created` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
32		# Update summary/description
33		if kwargs.get('summary'):
34		message.summary = kwargs['summary']
35
36		if kwargs.get('description'):
37		message.description = kwargs['description']
38
39		# Update `last_logged_at` timestamp
40		message.last_logged_at = datetime.utcnow()
41
42		# Update version details
43		message.version_base = VERSION_BASE
44		message.version_branch = VERSION_BRANCH
45
46		# Save changes to message
47		message.save()
48
49	1	return message
50
51	1	def from_exception(self, exception, message_type=Message.Type.Exception):
52		# Log exception
53		return self._log(
54		message_type,
55
56		# Query
57		Message.exception_hash == exception.hash,
58
59		# Parameters
60		exception_hash=exception.hash,
61
62		summary=exception.message,
63		description=exception.traceback
64		)
65
66	1	def from_message(self, level, message, code=None, description=None):
67		# Convert `level` to `Message.Type`
68	1	if level == logging.INFO:
69		type = Message.Type.Info
		0 ignored issues – show Bug Best Practice introduced 2015-12-19 01:32 UTC by Report Bug Copy Issue Report This seems to re-define the built-in `type`. It is generally discouraged to redefine built-ins as this makes code very hard to read. Loading history...
70	1	elif level == logging.WARNING:
71	1	type = Message.Type.Warning
72		elif level == logging.ERROR:
73		type = Message.Type.Error
74		elif level == logging.CRITICAL:
75		type = Message.Type.Critical
76		else:
77		raise ValueError('Unknown value for "level" parameter')
78
79		# Log message
80	1	return self._log(
81		type,
82
83		# Query
84		Message.code == code,
85
86		# Parameters
87		code=code,
88
89		summary=message,
90		description=description
91		)
92
93
94	1	class MessageManager(Manager):
95	1	get = GetMessage
96
97		model = Message
98

fuzeman / Plex-Trakt-Scrobbler

Push — develop ( b44848...2798d2 )

GetMessage.from_exception() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like