YamlContentReader._get_yaml_content() - Code Metrics - Inspection of "Fix method naming by pylint convention" - thatsIch/sublime-rainmeter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6a1037...604648 )

by thatsIch

created 2017-03-10 16:59 UTC

YamlContentReader._get_yaml_content() A

↳ Parent: YamlContentReader

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
c	2
b	0
f	0
dl	0
loc	14
rs	9.4285

"""This module is about reading YAML files for Rainmeter related definition files."""


import os.path
import zipfile

import sublime

from .. import logger



class YamlContentReader(object):  # pylint: disable=R0903; this is an abstract class
    """
    Use this to read the content of yamls inside of sublime text packages.

    supports multiple ways to access them:
    * .sublime-package
    * .zip
    * folder
    """

    @classmethod
    def __get_zip_content(cls, path_to_zip, resource):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        if not os.path.exists(path_to_zip):
            return None

        ret_value = None

        with zipfile.ZipFile(path_to_zip) as zip_file:
            namelist = zip_file.namelist()
            if resource in namelist:
                ret_value = zip_file.read(resource)
                return ret_value.decode("utf-8")

        logger.error("no zip content with resource '" + resource + "' found in .")

        return ret_value

    def __yaml_content_in_package(self, package, dir_of_yaml, yaml_file):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # try searching in Installed Packages e.g. if packaged in .sublime-package
        packages_path = sublime.installed_packages_path()
        sublime_package = package + ".sublime-package"
        rm_package_path = os.path.join(packages_path, sublime_package)
        if os.path.exists(rm_package_path):
            logger.info("found packaged resource in '" + rm_package_path + "'")
            resource = dir_of_yaml + yaml_file

            return self.__get_zip_content(rm_package_path, resource)

        return None

    def __yaml_content_by_sublime_api(self, dir_of_yaml, yaml_file):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # try over sublimes find resources first
        # should handle loose and packaged version
        for resource in sublime.find_resources(yaml_file):
            if dir_of_yaml in resource:
                logger.info(
                    "found sublime resource '" + dir_of_yaml + yaml_file + "' in '" + resource + "'"
                )
                return sublime.load_resource(resource)

    def __yaml_content_by_git_path(self, dir_of_yaml, yaml_file):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # try over absolute paths determined from root e.g. by cloning with git
        rm_root_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
        # the dir_of_yaml comes in as foo/bar but internally python uses foo\\bar
        norm_dir_of_yaml = os.path.normpath(dir_of_yaml)
        # e.g. Rainmeter + completion/skin + metadata_section.yaml
        yaml_path = os.path.join(rm_root_path, norm_dir_of_yaml, yaml_file)

        if os.path.exists(yaml_path):
            logger.info("found absolute resource in '" + yaml_path + "'")
            with open(yaml_path, 'r') as yaml_content_stream:
                return yaml_content_stream.read()

    @staticmethod
    def __fail(dir_of_yaml, yaml_file):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        logger.error(
            "found not yaml neither via sublime resources, nor absolute pathing, " +
            "nor .sublime-package for '" + dir_of_yaml + yaml_file + "'."
        )
        return None

    def _get_yaml_content(self, dir_of_yaml, yaml_file):
        """
        Get yaml content of a yaml file.

        It is located either in:
        * Installed Packages/Rainmeter.sublime-package
        * Packages/Rainmeter
        Parameters
        ----------
        """
        return self.__yaml_content_by_sublime_api(dir_of_yaml, yaml_file) or \
            self.__yaml_content_by_git_path(dir_of_yaml, yaml_file) or \
            self.__yaml_content_in_package("Rainmeter", dir_of_yaml, yaml_file) or \
            YamlContentReader.__fail(dir_of_yaml, yaml_file)


1			"""This module is about reading YAML files for Rainmeter related definition files."""
2
3
4			import os.path
5			import zipfile
6
7			import sublime
8
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
11
12			class YamlContentReader(object): # pylint: disable=R0903; this is an abstract class
13			"""
14			Use this to read the content of yamls inside of sublime text packages.
15
16			supports multiple ways to access them:
17			* .sublime-package
18			* .zip
19			* folder
20			"""
21
22			@classmethod
23			def __get_zip_content(cls, path_to_zip, resource):
			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...
24			if not os.path.exists(path_to_zip):
25			return None
26
27			ret_value = None
28
29			with zipfile.ZipFile(path_to_zip) as zip_file:
30			namelist = zip_file.namelist()
31			if resource in namelist:
32			ret_value = zip_file.read(resource)
33			return ret_value.decode("utf-8")
34
35			logger.error("no zip content with resource '" + resource + "' found in .")
36
37			return ret_value
38
39			def __yaml_content_in_package(self, package, dir_of_yaml, yaml_file):
			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...
40			# try searching in Installed Packages e.g. if packaged in .sublime-package
41			packages_path = sublime.installed_packages_path()
42			sublime_package = package + ".sublime-package"
43			rm_package_path = os.path.join(packages_path, sublime_package)
44			if os.path.exists(rm_package_path):
45			logger.info("found packaged resource in '" + rm_package_path + "'")
46			resource = dir_of_yaml + yaml_file
47
48			return self.__get_zip_content(rm_package_path, resource)
49
50			return None
51
52			def __yaml_content_by_sublime_api(self, dir_of_yaml, yaml_file):
			0 ignored issues – show Coding Style introduced 2017-02-03 19:51 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 2017-02-03 19:51 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...
53			# try over sublimes find resources first
54			# should handle loose and packaged version
55			for resource in sublime.find_resources(yaml_file):
56			if dir_of_yaml in resource:
57			logger.info(
58			"found sublime resource '" + dir_of_yaml + yaml_file + "' in '" + resource + "'"
59			)
60			return sublime.load_resource(resource)
61
62			def __yaml_content_by_git_path(self, dir_of_yaml, yaml_file):
			0 ignored issues – show Coding Style introduced 2017-02-03 19:51 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 2017-02-03 19:51 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...
63			# try over absolute paths determined from root e.g. by cloning with git
64			rm_root_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
65			# the dir_of_yaml comes in as foo/bar but internally python uses foo\\bar
66			norm_dir_of_yaml = os.path.normpath(dir_of_yaml)
67			# e.g. Rainmeter + completion/skin + metadata_section.yaml
68			yaml_path = os.path.join(rm_root_path, norm_dir_of_yaml, yaml_file)
69
70			if os.path.exists(yaml_path):
71			logger.info("found absolute resource in '" + yaml_path + "'")
72			with open(yaml_path, 'r') as yaml_content_stream:
73			return yaml_content_stream.read()
74
75			@staticmethod
76			def __fail(dir_of_yaml, yaml_file):
			0 ignored issues – show Coding Style introduced 2017-02-03 19:51 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...
77			logger.error(
78			"found not yaml neither via sublime resources, nor absolute pathing, " +
79			"nor .sublime-package for '" + dir_of_yaml + yaml_file + "'."
80			)
81			return None
82
83			def _get_yaml_content(self, dir_of_yaml, yaml_file):
84			"""
85			Get yaml content of a yaml file.
86
87			It is located either in:
88			* Installed Packages/Rainmeter.sublime-package
89			* Packages/Rainmeter
90			Parameters
91			----------
92			"""
93			return self.__yaml_content_by_sublime_api(dir_of_yaml, yaml_file) or \
94			self.__yaml_content_by_git_path(dir_of_yaml, yaml_file) or \
95			self.__yaml_content_in_package("Rainmeter", dir_of_yaml, yaml_file) or \
96			YamlContentReader.__fail(dir_of_yaml, yaml_file)
97

thatsIch / sublime-rainmeter

GitHub Access Token became invalid

Push — master ( 6a1037...604648 )

YamlContentReader._get_yaml_content() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like