Cache._skip_cache() - Code Metrics - Inspection of "Add watermark support" - jacebrowning/memegen - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#391)

by Jace

created 2017-06-29 23:17 UTC

Cache._skip_cache() B

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	7.116

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	7
c	1
b	0
f	0
dl	0
loc	19
ccs	13
cts	15
cp	0.8667
crap	7.116
rs	7.3333

import logging

import yorm
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
from yorm.types import List, Object
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
import profanityfilter
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3


log = logging.getLogger(__name__)


@yorm.attr(items=List.of_type(Object))
@yorm.sync("data/cache/{self.name}.yml")
class Cache:

    SIZE = 100

    def __init__(self, filtered=True):
        self.items = []
        self.disabled = False
        self.filtered = filtered

    @property
    def name(self):
        return 'filtered' if self.filtered else 'unfiltered'

    def add(self, **kwargs):
        if self._skip_cache(kwargs):
            return

        log.info("Caching: %s", kwargs)

        self.items.insert(0, kwargs)
        while len(self.items) > self.SIZE:
            self.items.pop()

    def get(self, index):
        log.info("Getting cache index: %s", index)

        try:
            data = self.items[index]
        except IndexError:
            data = {}

        log.info("Retrieved cache: %s", data)

        return data

    def _skip_cache(self, kwargs):
        if self.disabled:
            log.debug("Caching disabled")
            return True

        if kwargs in self.items:
            log.debug("Already cached: %s", kwargs)
            return True

        if self.filtered:

            if kwargs['key'] == 'custom' or kwargs.get('alt'):
                log.debug("Skipped caching of custom background: %s", kwargs)
                return True
            if profanityfilter.is_profane(kwargs['path']):
                log.debug("Skipped caching of profane content: %s", kwargs)
                return True

        return False


Pull Request — master (#391)

Cache._skip_cache() B

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1	1	import logging
2
3	1	import yorm
		0 ignored issues – show Configuration introduced 2017-04-18 13:04 UTC by Report Bug Copy Issue Report The import `yorm` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
4	1	from yorm.types import List, Object
		0 ignored issues – show Configuration introduced 2017-04-17 00:35 UTC by Report Bug Copy Issue Report The import `yorm.types` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
5	1	import profanityfilter
		0 ignored issues – show Configuration introduced 2016-09-28 03:11 UTC by Report Bug Copy Issue Report The import `profanityfilter` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
6
7
8	1	log = logging.getLogger(__name__)
9
10
11	1	@yorm.attr(items=List.of_type(Object))
12	1	@yorm.sync("data/cache/{self.name}.yml")
13		class Cache:
14
15	1	SIZE = 100
16
17	1	def __init__(self, filtered=True):
18	1	self.items = []
19	1	self.disabled = False
20	1	self.filtered = filtered
21
22	1	@property
23		def name(self):
24	1	return 'filtered' if self.filtered else 'unfiltered'
25
26	1	def add(self, **kwargs):
27	1	if self._skip_cache(kwargs):
28	1	return
29
30	1	log.info("Caching: %s", kwargs)
31
32	1	self.items.insert(0, kwargs)
33	1	while len(self.items) > self.SIZE:
34		self.items.pop()
35
36	1	def get(self, index):
37	1	log.info("Getting cache index: %s", index)
38
39	1	try:
40	1	data = self.items[index]
41	1	except IndexError:
42	1	data = {}
43
44	1	log.info("Retrieved cache: %s", data)
45
46	1	return data
47
48	1	def _skip_cache(self, kwargs):
49	1	if self.disabled:
50		log.debug("Caching disabled")
51		return True
52
53	1	if kwargs in self.items:
54	1	log.debug("Already cached: %s", kwargs)
55	1	return True
56
57	1	if self.filtered:
58
59	1	if kwargs['key'] == 'custom' or kwargs.get('alt'):
60	1	log.debug("Skipped caching of custom background: %s", kwargs)
61	1	return True
62	1	if profanityfilter.is_profane(kwargs['path']):
63	1	log.debug("Skipped caching of profane content: %s", kwargs)
64	1	return True
65
66		return False
67

jacebrowning / memegen

Pull Request — master (#391)

Cache._skip_cache() B

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files

2. Missing init.py files

2. Missing init.py files