CreditCallsGroupOptimizationStrategy.should_continue() - Code Metrics - Inspection of "Feature/inteligent credits (#61)" - qbahn/grortir - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9d1fce...45e830 )

by Wojtek

created 2017-02-27 18:06 UTC

should_continue() A

↳ Parent: CreditCallsGroupOptimizationStrategy

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

import numpy as np
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

from grortir.main.pso.group_optimization_strategy import \
    GroupOptimizationStrategy


class CreditCallsGroupOptimizationStrategy(GroupOptimizationStrategy):
    """Optimization with credits.
        Attributes:
            stages_in_group (list): stages in group
            process (AbstractProcess): optimized process
            max_calls_for_group (int): max calls which can be
                used for this group
            expected_quality (float): expected quality
    """

    def __init__(self, stages_in_group, process):
        self.stages_in_group = stages_in_group
        self.process = process
        self.max_calls_for_group = 0
        self.expected_quality = np.inf

    def initialize(self):

        """
            Called once and set initial value of max_calls_for_group.
        """
        if self._calculate_current_cost_in_group() != 0:
            raise ValueError(
                "Stages in group shouldn't started with initial cost.")
        all_initial_calls = 0
        already_used_calls = 0
        all_stages = self.process.nodes()
        for stage in all_stages:
            all_initial_calls += stage.get_maximal_acceptable_cost()
        for stage in all_stages:
            already_used_calls += stage.get_cost()
        self.max_calls_for_group = all_initial_calls - already_used_calls

        for stage in self.stages_in_group:
            if self.expected_quality > stage.maximum_acceptable_quality:
                self.expected_quality = stage.maximum_acceptable_quality

    def should_continue(self, best_particle):

        """

        Args:
            best_particle Particle: best particle in swarm.

        Returns:
            bool: true if continuation is required.

        """
        return self._is_safe_cost() and not self._is_enough_quality(
            best_particle)

    def _is_safe_cost(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return (
            self._calculate_current_cost_in_group() <= self.max_calls_for_group)

    def _is_enough_quality(self, best_particle):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return best_particle.best_quality <= self.expected_quality

    def _calculate_current_cost_in_group(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        calls_used_in_group = 0
        for stage in self.stages_in_group:
            calls_used_in_group += stage.get_cost()
        return calls_used_in_group


Push — master ( 9d1fce...45e830 )

should_continue() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1	1	import numpy as np
		0 ignored issues – show Coding Style introduced 2017-02-27 18:04 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... Configuration introduced 2017-02-27 18:04 UTC by Report Bug Copy Issue Report The import `numpy` 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...
2
3	1	from grortir.main.pso.group_optimization_strategy import \
4		GroupOptimizationStrategy
5
6
7	1	class CreditCallsGroupOptimizationStrategy(GroupOptimizationStrategy):
8		"""Optimization with credits.
9		Attributes:
10		stages_in_group (list): stages in group
11		process (AbstractProcess): optimized process
12		max_calls_for_group (int): max calls which can be
13		used for this group
14		expected_quality (float): expected quality
15		"""
16
17	1	def __init__(self, stages_in_group, process):
18	1	self.stages_in_group = stages_in_group
19	1	self.process = process
20	1	self.max_calls_for_group = 0
21	1	self.expected_quality = np.inf
22
23	1	def initialize(self):
		0 ignored issues – show Bug introduced 2017-02-27 18:04 UTC by Report Bug Copy Issue Report Arguments number differs from overridden 'initialize' method Loading history...
24		"""
25		Called once and set initial value of max_calls_for_group.
26		"""
27	1	if self._calculate_current_cost_in_group() != 0:
28	1	raise ValueError(
29		"Stages in group shouldn't started with initial cost.")
30	1	all_initial_calls = 0
31	1	already_used_calls = 0
32	1	all_stages = self.process.nodes()
33	1	for stage in all_stages:
34	1	all_initial_calls += stage.get_maximal_acceptable_cost()
35	1	for stage in all_stages:
36	1	already_used_calls += stage.get_cost()
37	1	self.max_calls_for_group = all_initial_calls - already_used_calls
38
39	1	for stage in self.stages_in_group:
40	1	if self.expected_quality > stage.maximum_acceptable_quality:
41	1	self.expected_quality = stage.maximum_acceptable_quality
42
43	1	def should_continue(self, best_particle):
		0 ignored issues – show Bug introduced 2017-02-27 18:04 UTC by Report Bug Copy Issue Report Arguments number differs from overridden 'should_continue' method Loading history...
44		"""
45
46		Args:
47		best_particle Particle: best particle in swarm.
48
49		Returns:
50		bool: true if continuation is required.
51
52		"""
53	1	return self._is_safe_cost() and not self._is_enough_quality(
54		best_particle)
55
56	1	def _is_safe_cost(self):
		0 ignored issues – show Coding Style introduced 2017-02-27 18:04 UTC by Report Bug Copy Issue Report This method 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...
57	1	return (
58		self._calculate_current_cost_in_group() <= self.max_calls_for_group)
59
60	1	def _is_enough_quality(self, best_particle):
		0 ignored issues – show Coding Style introduced 2017-02-27 18:04 UTC by Report Bug Copy Issue Report This method 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...
61	1	return best_particle.best_quality <= self.expected_quality
62
63	1	def _calculate_current_cost_in_group(self):
		0 ignored issues – show Coding Style Naming introduced 2017-02-27 18:04 UTC by Report Bug Copy Issue Report The name `_calculate_current_cost_in_group` does not conform to the method naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history... Coding Style introduced 2017-02-27 18:04 UTC by Report Bug Copy Issue Report This method 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...
64	1	calls_used_in_group = 0
65	1	for stage in self.stages_in_group:
66	1	calls_used_in_group += stage.get_cost()
67		return calls_used_in_group
68

qbahn / grortir

Push — master ( 9d1fce...45e830 )

should_continue() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files