SkinMetadataSectionAutoComplete.get_key_context_completion() - Code Metrics - Inspection of "Refactored key and value compiler into own module..." - thatsIch/sublime-rainmeter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 115f31...f9d160 )

by thatsIch

created 2017-01-11 13:04 UTC

get_key_context_completion() B

↳ Parent: SkinMetadataSectionAutoComplete

Complexity

Conditions

Size

Total Lines

Duplication

Lines	27
Ratio	100 %

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
cc	5
c	5
b	0
f	0
dl	27
loc	27
rs	8.0894

"""This module is about skin/metadata section completion."""


import yaml

import sublime

# import own libs
from ... import logger

from ..levenshtein import levenshtein
from ..compiler import compile_keys
from ..yaml_content_reader import YamlContentReader


class SkinMetadataSectionAutoComplete(YamlContentReader):  # pylint: disable=R0903; only provide one method

    """This uses the provided YAML files to extract the possible completions."""

    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(error)
            return []

    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 = compile_keys(self.all_completions)

    def __filter_completions_by_keys(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:
            dummy_key, display, content, dummy_unique = completion

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

            if contained == 0:
                completions.append((display, content))

        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):
        """
        Get context completion for a key.

        This implies that it was entered in a non-key row.
        """
        if section.casefold() != "Metadata".casefold():
            return None

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

        # no results, means all keys are used up
        if not completions:
            logger.info("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		"""This module is about skin/metadata section completion."""
2
3
4		import yaml
5
6		import sublime
7
8		# import own libs
9		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...
10		from ..levenshtein import levenshtein
11		from ..compiler import compile_keys
12		from ..yaml_content_reader import YamlContentReader
13
14
15	View Code Duplication	class SkinMetadataSectionAutoComplete(YamlContentReader): # pylint: disable=R0903; only provide one method
		0 ignored issues – show Duplication introduced 2016-12-18 19:14 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
16		"""This uses the provided YAML files to extract the possible completions."""
17
18		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...
19		try:
20		skin_metadata_section_content = self._get_yaml_content(
21		"completion/skin/",
22		"metadata_section.yaml"
23		)
24		skin_metadata_section = yaml.load(skin_metadata_section_content)
25
26		return skin_metadata_section
27
28		except yaml.YAMLError as error:
29		logger.error(error)
30		return []
31
32		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...
33		# use lazy initialization because else the API is not available yet
34		if not self.all_completions:
35		self.all_completions = self.__get_completions()
36		self.all_key_completions = compile_keys(self.all_completions)
37
38		def __filter_completions_by_keys(self, keyvalues):
39		"""
40		In Rainmeter a key can only be used once in a section statement.
41
42		If you declare it twice this is a code smell.
43		"""
44		# filter by already existing keys
45		completions = []
46
47		for completion in self.all_key_completions:
48		dummy_key, display, content, dummy_unique = completion
49
50		contained = 0
51		# value not used here
52		for key, _ in keyvalues:
53		if key.casefold() == content.casefold():
54		contained = 1
55		break
56
57		if contained == 0:
58		completions.append((display, content))
59
60		return completions
61
62		# only show our completion list because nothing else makes sense in this context
63		flags = sublime.INHIBIT_EXPLICIT_COMPLETIONS \| sublime.INHIBIT_WORD_COMPLETIONS
64
65		all_completions = None
66		all_key_completions = None
67
68		def get_key_context_completion(self, prefix, line_content, section, keyvalues):
69		"""
70		Get context completion for a key.
71
72		This implies that it was entered in a non-key row.
73		"""
74		if section.casefold() != "Metadata".casefold():
75		return None
76
77		self.__lazy_initialize_completions()
78		completions = self.__filter_completions_by_keys(keyvalues)
79
80		# no results, means all keys are used up
81		if not completions:
82		logger.info("no results, all keys are used up")
83		return None
84
85		# only show sorted by distance if something was already typed
86		# because distance to empty string makes no sense
87		if line_content != "":
88		# sort by levenshtein distance
89		sorted_completions = sorted(
90		completions, key=lambda completion: levenshtein(completion[1], prefix)
91		)
92		return sorted_completions, self.flags
93		else:
94		return completions, self.flags
95

thatsIch / sublime-rainmeter

GitHub Access Token became invalid

Push — master ( 115f31...f9d160 )

get_key_context_completion() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like