_get_rm_path_from_registry() - Code Metrics - Inspection of "Cleanup program path provider" - thatsIch/sublime-rainmeter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8b7fe1...f5fa7f )

by thatsIch

created 2016-12-14 15:53 UTC

_get_rm_path_from_registry() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

"""This module is about path resolving for the program path.

This is required to execute Rainmeter.exe for example to refresh the current skin.
"""

import os
import winreg

from functools import lru_cache

import sublime

from .. import logger



def _get_rm_path_from_default_path():
    r"""
    Default location is "C:\Program Files\Rainmeter" in windows.

    We can get "C:\Program Files" through the environmental variables
    %PROGRAMFILES%
    """
    programfiles = os.getenv("PROGRAMFILES")
    rainmeterpath = os.path.join(programfiles, "Rainmeter")

    return rainmeterpath


def _get_rainmeter_registry_key():
    r"""
    Throw FileNotFoundException if Software\WOW6432Node\Rainmeter does not exist.

    not much we can do to handle that
    """
    return winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, "SOFTWARE\\WOW6432Node\\Rainmeter")


def _get_rm_path_from_registry():
    """Registry."""
    rainmeter_key = _get_rainmeter_registry_key()
    rainmeter_path = winreg.QueryValue(rainmeter_key, None)

    return rainmeter_path


def __executable_exists(rm_path):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    # normalize path
    rainmeter_exe = os.path.join(rm_path, "Rainmeter.exe")
    if not os.path.exists(rainmeter_exe):
        message = """Rainmeter path was found, but no Rainmeter.exe found.
                     Check if you have installed Rainmeter correctly."""
        logger.error(__file__, "get_cached_program_path()", message)
        sublime.error_message(message)
        return False

    return True

@lru_cache(maxsize=None)
def get_cached_program_path():
    """Try to retrieve the program path of RM through magic.

    Possible options are:

    * It is given through settings
    * It is in the default installation path
    * It is registered in the registry
    * Ask the user for the path
    """
    # Load setting
    settings = sublime.load_settings("Rainmeter.sublime-settings")
    rm_path = settings.get("rainmeter_path", None)

    # If setting is not set, try default location
    if not rm_path:
        logger.info(
            __file__,
            "get_cached_program_path()",
            "rainmeter_path not found in settings. Trying default location."
        )
        rm_path = _get_rm_path_from_default_path()

    # if it is not even specified by default,
    # try using the registry to retrieve the installation path
    if not os.path.isdir(rm_path):
        rm_path = _get_rm_path_from_registry()

    # Check if path exists and contains Rainmeter.exe
    if not os.path.isdir(rm_path):
        message = """Path to Rainmeter.exe could neither be found:
                     
                     * in the settings,
                     * in the standard directory,
                     * nor via registry.

                     Check your \"rainmeter_path\" setting."""
        logger.info(__file__, "get_cached_program_path()", message)
        sublime.error_message(message)
        return

    if not __executable_exists(rm_path):
        return

    logger.info(__file__, "get_cached_program_path()", "Rainmeter found in " + rm_path)
    return rm_path + "\\"


1			"""This module is about path resolving for the program path.
2
3			This is required to execute Rainmeter.exe for example to refresh the current skin.
4			"""
5
6			import os
7			import winreg
8
9			from functools import lru_cache
10
11			import sublime
12
13			from .. import logger
			1 ignored issue – 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 `path`. Loading history...
14
15
16			def _get_rm_path_from_default_path():
17			r"""
18			Default location is "C:\Program Files\Rainmeter" in windows.
19
20			We can get "C:\Program Files" through the environmental variables
21			%PROGRAMFILES%
22			"""
23			programfiles = os.getenv("PROGRAMFILES")
24			rainmeterpath = os.path.join(programfiles, "Rainmeter")
25
26			return rainmeterpath
27
28
29			def _get_rainmeter_registry_key():
30			r"""
31			Throw FileNotFoundException if Software\WOW6432Node\Rainmeter does not exist.
32
33			not much we can do to handle that
34			"""
35			return winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, "SOFTWARE\\WOW6432Node\\Rainmeter")
36
37
38			def _get_rm_path_from_registry():
39			"""Registry."""
40			rainmeter_key = _get_rainmeter_registry_key()
41			rainmeter_path = winreg.QueryValue(rainmeter_key, None)
42
43			return rainmeter_path
44
45
46			def __executable_exists(rm_path):
			0 ignored issues – show Coding Style introduced 2016-12-14 15:55 UTC by Report Bug Copy Issue Report This function 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...
47			# normalize path
48			rainmeter_exe = os.path.join(rm_path, "Rainmeter.exe")
49			if not os.path.exists(rainmeter_exe):
50			message = """Rainmeter path was found, but no Rainmeter.exe found.
51			Check if you have installed Rainmeter correctly."""
52			logger.error(__file__, "get_cached_program_path()", message)
53			sublime.error_message(message)
54			return False
55
56			return True
57
58			@lru_cache(maxsize=None)
59			def get_cached_program_path():
60			"""Try to retrieve the program path of RM through magic.
61
62			Possible options are:
63
64			* It is given through settings
65			* It is in the default installation path
66			* It is registered in the registry
67			* Ask the user for the path
68			"""
69			# Load setting
70			settings = sublime.load_settings("Rainmeter.sublime-settings")
71			rm_path = settings.get("rainmeter_path", None)
72
73			# If setting is not set, try default location
74			if not rm_path:
75			logger.info(
76			__file__,
77			"get_cached_program_path()",
78			"rainmeter_path not found in settings. Trying default location."
79			)
80			rm_path = _get_rm_path_from_default_path()
81
82			# if it is not even specified by default,
83			# try using the registry to retrieve the installation path
84			if not os.path.isdir(rm_path):
85			rm_path = _get_rm_path_from_registry()
86
87			# Check if path exists and contains Rainmeter.exe
88			if not os.path.isdir(rm_path):
89			message = """Path to Rainmeter.exe could neither be found:
90
91			* in the settings,
92			* in the standard directory,
93			* nor via registry.
94
95			Check your \"rainmeter_path\" setting."""
96			logger.info(__file__, "get_cached_program_path()", message)
97			sublime.error_message(message)
98			return
99
100			if not __executable_exists(rm_path):
101			return
102
103			logger.info(__file__, "get_cached_program_path()", "Rainmeter found in " + rm_path)
104			return rm_path + "\\"
105

thatsIch / sublime-rainmeter

GitHub Access Token became invalid

Push — master ( 8b7fe1...f5fa7f )

_get_rm_path_from_registry() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like