SkinMetadataSectionAutoComplete.get_key_context_completion() - Code Metrics - Inspection of "Fixed missing return statement while filtering the..." - thatsIch/sublime-rainmeter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 04aa04...031d16 )

by thatsIch

created 2016-12-10 15:07 UTC

get_key_context_completion() B

↳ Parent: SkinMetadataSectionAutoComplete

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	7
Bugs	0	Features	0

Metric	Value
cc	5
c	7
b	0
f	0
dl	0
loc	23
rs	8.2508

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

import sublime

# import own libs
from ... import logger

from ...completion.levenshtein import levenshtein

from ...completion.yaml_content_reader import YamlContentReader



class SkinMetadataSectionAutoComplete(YamlContentReader):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    def __get_completions(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        try:
            skin_metadata_section_content = self._get_yaml_content("completion/skin/", "metadata_section.yaml")
            skin_metadata_section = yaml.load(skin_metadata_section_content)

            return skin_metadata_section

        except yaml.YAMLError as error:
            logger.error(__file__, "get_completions", error)
            return []

    def __get_compiled_key_completions(self, options):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        keys = []
        for option in options:
            title = option['title'] + "\t" + option['hint']

            if 'value' in option:
                result = option['value']
            else:
                result = option['title']

            pair = (title, result)
            keys.append(pair)

        return keys

    def __lazy_initialize_completions(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # use lazy initialization because else the API is not available yet
        if not self.all_completions:
            self.all_completions = self.__get_completions()
            self.all_key_completions = self.__get_compiled_key_completions(self.all_completions)

    def __filter_completions_by_key_already_used(self, keyvalues):

        """
        In Rainmeter a key can only be used once in a section statement.
        If you declare it twice this is a code smell.
        """
        # filter by already existing keys
        completions = []

        for completion in self.all_key_completions:
            # trigger is not used here
            _, content = completion

            contained = 0
            # value not used here
            for key, _ in keyvalues:
                if key.casefold() == content.casefold():
                    contained = 1
                    break

            if contained == 0:
                completions.append(completion)

        return completions

    # only show our completion list because nothing else makes sense in this context
    flags = sublime.INHIBIT_EXPLICIT_COMPLETIONS | sublime.INHIBIT_WORD_COMPLETIONS

    all_completions = None
    all_key_completions = None

    def get_key_context_completion(self, prefix, line_content, section, keyvalues):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        if section.casefold() != "Metadata".casefold():
            return None

        self.__lazy_initialize_completions()
        completions = self.__filter_completions_by_key_already_used(keyvalues)

        # no results, means all keys are used up
        if not completions:
            logger.info(
                __file__,
                "get_key_context_completion",
                "no results, all keys are used up"
            )
            return None

        # only show sorted by distance if something was already typed because distance to empty string makes no sense
        if line_content != "":
            # sort by levenshtein distance
            sorted_completions = sorted(completions, key=lambda completion: levenshtein(completion[1], prefix))
            return sorted_completions, self.flags
        else:
            return completions, self.flags


1			import yaml
			0 ignored issues – show Coding Style introduced 2016-12-09 22:27 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			import sublime
4
5			# import own libs
6			from ... import logger
			0 ignored issues – show Bug introduced 2016-12-09 22:27 UTC by Report Bug Copy Issue Report The name `logger` does not seem to exist in module `completion`. Loading history...
7			from ...completion.levenshtein import levenshtein
			0 ignored issues – show Bug introduced 2016-12-09 22:27 UTC by Report Bug Copy Issue Report The name `levenshtein` does not seem to exist in module `completion.completion`. Loading history...
8			from ...completion.yaml_content_reader import YamlContentReader
			0 ignored issues – show Bug introduced 2016-12-09 22:27 UTC by Report Bug Copy Issue Report The name `yaml_content_reader` does not seem to exist in module `completion.completion`. Loading history...
9
10
11			class SkinMetadataSectionAutoComplete(YamlContentReader):
			0 ignored issues – show Coding Style introduced 2016-12-09 22:27 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...
12
13			def __get_completions(self):
			0 ignored issues – show Coding Style introduced 2016-12-09 22:27 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...
14			try:
15			skin_metadata_section_content = self._get_yaml_content("completion/skin/", "metadata_section.yaml")
16			skin_metadata_section = yaml.load(skin_metadata_section_content)
17
18			return skin_metadata_section
19
20			except yaml.YAMLError as error:
21			logger.error(__file__, "get_completions", error)
22			return []
23
24			def __get_compiled_key_completions(self, options):
			0 ignored issues – show Coding Style introduced 2016-12-09 22:27 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... Coding Style introduced 2016-12-09 22:27 UTC by Report Bug Copy Issue Report This method could be written as a function/class method. If a method does not access any attributes of the class, it could also be implemented as a function or static method. This can help improve readability. For example class Foo: def some_method(self, x, y): return x + y; could be written as class Foo: @classmethod def some_method(cls, x, y): return x + y; Loading history...
25			keys = []
26			for option in options:
27			title = option['title'] + "\t" + option['hint']
28
29			if 'value' in option:
30			result = option['value']
31			else:
32			result = option['title']
33
34			pair = (title, result)
35			keys.append(pair)
36
37			return keys
38
39			def __lazy_initialize_completions(self):
			0 ignored issues – show Coding Style introduced 2016-12-10 14:49 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...
40			# use lazy initialization because else the API is not available yet
41			if not self.all_completions:
42			self.all_completions = self.__get_completions()
43			self.all_key_completions = self.__get_compiled_key_completions(self.all_completions)
44
45			def __filter_completions_by_key_already_used(self, keyvalues):
			0 ignored issues – show Coding Style Naming introduced 2016-12-10 14:49 UTC by Report Bug Copy Issue Report The name `__filter_completions_by_key_already_used` 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...
46			"""
47			In Rainmeter a key can only be used once in a section statement.
48			If you declare it twice this is a code smell.
49			"""
50			# filter by already existing keys
51			completions = []
52
53			for completion in self.all_key_completions:
54			# trigger is not used here
55			_, content = completion
56
57			contained = 0
58			# value not used here
59			for key, _ in keyvalues:
60			if key.casefold() == content.casefold():
61			contained = 1
62			break
63
64			if contained == 0:
65			completions.append(completion)
66
67			return completions
68
69			# only show our completion list because nothing else makes sense in this context
70			flags = sublime.INHIBIT_EXPLICIT_COMPLETIONS \| sublime.INHIBIT_WORD_COMPLETIONS
71
72			all_completions = None
73			all_key_completions = None
74
75			def get_key_context_completion(self, prefix, line_content, section, keyvalues):
			0 ignored issues – show Coding Style introduced 2016-12-09 22:27 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...
76			if section.casefold() != "Metadata".casefold():
77			return None
78
79			self.__lazy_initialize_completions()
80			completions = self.__filter_completions_by_key_already_used(keyvalues)
81
82			# no results, means all keys are used up
83			if not completions:
84			logger.info(
85			__file__,
86			"get_key_context_completion",
87			"no results, all keys are used up"
88			)
89			return None
90
91			# only show sorted by distance if something was already typed because distance to empty string makes no sense
92			if line_content != "":
93			# sort by levenshtein distance
94			sorted_completions = sorted(completions, key=lambda completion: levenshtein(completion[1], prefix))
95			return sorted_completions, self.flags
96			else:
97			return completions, self.flags
98

thatsIch / sublime-rainmeter

GitHub Access Token became invalid

Push — master ( 04aa04...031d16 )

get_key_context_completion() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like