SkinRainmeterSectionAutoComplete.get_compiled_value_completions() - 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_compiled_value_completions() D

↳ Parent: SkinRainmeterSectionAutoComplete

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	8
c	3
b	0
f	0
dl	0
loc	39
rs	4

"""This module is about the skin/rainmeter section handling."""


import yaml

import sublime

# import own libs
from ... import logger

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


class SkinRainmeterSectionAutoComplete(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:
            rainmeter_section_content = self._get_yaml_content(
                "completion/skin/",
                "rainmeter_section.yaml"
            )
            skin_rainmeter_section = yaml.load(rainmeter_section_content)

            general_image_options_content = self._get_yaml_content(
                "completion/meter/",
                "general_image_options.yaml"
            )
            meters_general_image_options = yaml.load(general_image_options_content)

            skin_rainmeter_section.extend(meters_general_image_options)

            return skin_rainmeter_section

        except yaml.YAMLError as error:
            logger.error(error)
            return []

    # 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
    all_value_completions = None

    def get_key_context_completion(self, prefix, line_content, section, keyvalues):
        """Get a list of keys for the current context."""
        if section.casefold() != "Rainmeter".casefold():
            return None

        # 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)

        # filter by already existing keys
        completions = []

        for completion in self.all_key_completions:
            dummy_key, display, content, dummy_unique = completion

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

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

        # no results, means all keys are used up
        if not completions:
            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 c: levenshtein(c[1], prefix)
            )

            return sorted_completions, self.flags
        else:
            return completions, self.flags

    def get_value_context_completion(self, section, key_match):
        """Get context completion for a specified found key."""
        if section != "Rainmeter":
            return None

        # use lazy initialization because else the API is not available yet
        if not self.all_completions:
            self.all_completions = self.__get_completions()

        if not self.all_value_completions:
            self.all_value_completions = compile_values(self.all_completions)

        value_completions = self.all_value_completions[key_match]

        if not value_completions:
            return None
        else:
            return value_completions, self.flags


1			"""This module is about the skin/rainmeter section handling."""
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, compile_values
12			from ..yaml_content_reader import YamlContentReader
13
14
15			class SkinRainmeterSectionAutoComplete(YamlContentReader): # pylint: disable=R0903; only provide one method
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			rainmeter_section_content = self._get_yaml_content(
21			"completion/skin/",
22			"rainmeter_section.yaml"
23			)
24			skin_rainmeter_section = yaml.load(rainmeter_section_content)
25
26			general_image_options_content = self._get_yaml_content(
27			"completion/meter/",
28			"general_image_options.yaml"
29			)
30			meters_general_image_options = yaml.load(general_image_options_content)
31
32			skin_rainmeter_section.extend(meters_general_image_options)
33
34			return skin_rainmeter_section
35
36			except yaml.YAMLError as error:
37			logger.error(error)
38			return []
39
40			# only show our completion list because nothing else makes sense in this context
41			flags = sublime.INHIBIT_EXPLICIT_COMPLETIONS \| sublime.INHIBIT_WORD_COMPLETIONS
42
43			all_completions = None
44			all_key_completions = None
45			all_value_completions = None
46
47			def get_key_context_completion(self, prefix, line_content, section, keyvalues):
48			"""Get a list of keys for the current context."""
49			if section.casefold() != "Rainmeter".casefold():
50			return None
51
52			# use lazy initialization because else the API is not available yet
53			if not self.all_completions:
54			self.all_completions = self.__get_completions()
55			self.all_key_completions = compile_keys(self.all_completions)
56
57			# filter by already existing keys
58			completions = []
59
60			for completion in self.all_key_completions:
61			dummy_key, display, content, dummy_unique = completion
62
63			contained = 0
64			# value not needed
65			for key, _ in keyvalues:
66			if key.casefold() == content.casefold():
67			contained = 1
68			break
69
70			if contained == 0:
71			completions.append((display, content))
72
73			# no results, means all keys are used up
74			if not completions:
75			return None
76
77			# only show sorted by distance if something was already typed
78			# because distance to empty string makes no sense
79			if line_content != "":
80			# sort by levenshtein distance
81			sorted_completions = sorted(
82			completions, key=lambda c: levenshtein(c[1], prefix)
83			)
84
85			return sorted_completions, self.flags
86			else:
87			return completions, self.flags
88
89			def get_value_context_completion(self, section, key_match):
90			"""Get context completion for a specified found key."""
91			if section != "Rainmeter":
92			return None
93
94			# use lazy initialization because else the API is not available yet
95			if not self.all_completions:
96			self.all_completions = self.__get_completions()
97
98			if not self.all_value_completions:
99			self.all_value_completions = compile_values(self.all_completions)
100
101			value_completions = self.all_value_completions[key_match]
102
103			if not value_completions:
104			return None
105			else:
106			return value_completions, self.flags
107

thatsIch / sublime-rainmeter

GitHub Access Token became invalid

Push — master ( 115f31...f9d160 )

get_compiled_value_completions() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like