LibrariesManager._insert_paths() - Code Metrics - Inspection of "Merge branch 'issue/293' into develop" - fuzeman/Plex-Trakt-Scrobbler - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( de3ad7...3c2cc7 )

by Dean

created 2016-04-10 23:01 UTC

LibrariesManager._insert_paths() B

↳ Parent: LibrariesManager

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	4.0466

Metric	Value
cc	4
dl	0
loc	26
ccs	12
cts	14
cp	0.8571
crap	4.0466
rs	8.5806

from plugin.core.configuration import Configuration
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
from plugin.core.environment import Environment
from plugin.core.helpers.variable import merge
from plugin.core.libraries.cache import CacheManager
from plugin.core.libraries.constants import CONTENTS_PATH, NATIVE_DIRECTORIES, UNICODE_MAP
from plugin.core.libraries.helpers import PathHelper, StorageHelper, SystemHelper
from plugin.core.libraries.tests import LIBRARY_TESTS
from plugin.core.logger.handlers.error_reporter import RAVEN
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

import logging
import os
import platform
import sys

log = logging.getLogger(__name__)


class LibrariesManager(object):
    @classmethod
    def setup(cls, cache=False):
        """Setup native library directories

        :param cache: Enable native library caching
        :type cache: bool
        """

        # Use `cache` value from advanced configuration
        cache = Configuration.advanced['libraries'].get_boolean('cache', cache)

        # Retrieve libraries path (and cache libraries, if enabled)
        libraries_path = cls._libraries_path(cache)

        if not libraries_path:
            return

        log.info('Using native libraries at %r', StorageHelper.to_relative_path(libraries_path))

        # Remove current native library directories from `sys.path`
        cls.reset()

        # Insert platform specific library paths
        cls._insert_paths(libraries_path)

        # Display library paths in logfile
        for path in sys.path:
            path = os.path.abspath(path)

            if StorageHelper.is_framework_path(path):
                continue

            log.info('[PATH] %s', StorageHelper.to_relative_path(path))

    @staticmethod
    def test():
        """Test native libraries to ensure they can be correctly loaded"""
        log.info('Testing native library support...')

        metadata = {}

        for test in LIBRARY_TESTS:
            # Run tests
            result = test.run()


            if not result.get('success'):
                # Write message to logfile
                log.error('%s: unavailable - %s', test.name, result.get('message'), exc_info=result.get('exc_info'))

                if not test.optional:
                    return

                continue

            # Test successful
            t_metadata = result.get('metadata') or {}
            t_versions = t_metadata.get('versions')

            if t_versions:
                if len(t_versions) > 1:
                    log.info('%s: available (%s)', test.name, ', '.join([
                        '%s: %s' % (key, value)
                        for key, value in t_versions.items()
                    ]))
                else:
                    key = t_versions.keys()[0]

                    log.info('%s: available (%s)', test.name, t_versions[key])
            else:
                log.info('%s: available', test.name)

            # Merge result into `metadata`
            merge(metadata, t_metadata, recursive=True)

        # Include versions in error reports
        versions = metadata.get('versions') or {}

        RAVEN.tags.update(dict([
            ('%s.version' % key, value)
            for key, value in versions.items()
        ]))

    @classmethod
    def reset(cls):
        """Remove all the native library directives from `sys.path`"""

        for path in sys.path:
            path = os.path.abspath(path)

            if not path.lower().startswith(CONTENTS_PATH.lower()):
                continue

            # Convert to relative path
            path_rel = os.path.relpath(path, CONTENTS_PATH)

            # Take the first two fragments
            path_rel = os.path.sep.join(path_rel.split(os.path.sep)[:2])

            # Convert to unix-style separators (/)
            path_rel = path_rel.replace('\\', '/')

            # Ignore non-native library directories
            if path_rel not in NATIVE_DIRECTORIES:
                continue

            # Remove from `sys.path`
            PathHelper.remove(path)

    @classmethod
    def _libraries_path(cls, cache=False):
        """Retrieve the native libraries base directory (and cache the libraries if enabled)

        :param cache: Enable native library caching
        :type cache: bool
        """

        # Use specified libraries path (from "advanced.ini')
        libraries_path = Configuration.advanced['libraries'].get('libraries_path')

        if libraries_path and os.path.exists(libraries_path):
            log.info('Using libraries at %r', StorageHelper.to_relative_path(libraries_path))
            RAVEN.tags.update({'libraries.source': 'custom'})
            return libraries_path

        # Use system libraries (if bundled libraries have been disabled in "advanced.ini")
        if not Configuration.advanced['libraries'].get_boolean('bundled', True):
            log.info('Bundled libraries have been disabled, using system libraries')
            RAVEN.tags.update({'libraries.source': 'system'})
            return None

        # Cache libraries (if enabled)
        if cache:
            RAVEN.tags.update({'libraries.source': 'cache'})
            return cls._cache_libraries()

        RAVEN.tags.update({'libraries.source': 'bundle'})
        return Environment.path.libraries

    @classmethod
    def _cache_libraries(cls):
        cache_path = Configuration.advanced['libraries'].get('cache_path')

        # Try cache libraries to `cache_path`
        libraries_path = CacheManager.sync(cache_path)

        if not libraries_path:
            log.info('Unable to cache libraries, using bundled libraries directly')
            return Environment.path.libraries

        log.info('Cached libraries to %r', StorageHelper.to_relative_path(libraries_path))
        return libraries_path

    @classmethod
    def _insert_paths(cls, libraries_path):
        # Display platform details
        p_bits, _ = platform.architecture()
        p_machine = platform.machine()

        log.debug('Bits: %r, Machine: %r', p_bits, p_machine)

        # Retrieve system details
        system = SystemHelper.name()
        architecture = SystemHelper.architecture()

        if not architecture:
            return

        log.debug('System: %r, Architecture: %r', system, architecture)

        # Insert architecture specific libraries
        architectures = [architecture]

        if architecture == 'i686':
            # Fallback to i386
            architectures.append('i386')

        for arch in architectures + ['universal']:
            cls._insert_architecture_paths(libraries_path, system, arch)

    @classmethod
    def _insert_architecture_paths(cls, libraries_path, system, architecture):
        architecture_path = os.path.join(libraries_path, system, architecture)

        if not os.path.exists(architecture_path):
            return

        # Architecture libraries
        PathHelper.insert(libraries_path, system, architecture)

        # System libraries
        if system == 'Windows':
            # Windows libraries (VC++ specific)
            cls._insert_paths_windows(libraries_path, system, architecture)
        else:
            # Darwin/FreeBSD/Linux libraries
            cls._insert_paths_unix(libraries_path, system, architecture)

    @staticmethod
    def _insert_paths_unix(libraries_path, system, architecture):
        # UCS specific libraries
        ucs = UNICODE_MAP.get(sys.maxunicode)
        log.debug('UCS: %r', ucs)

        if ucs:
            PathHelper.insert(libraries_path, system, architecture, ucs)

        # CPU specific libraries
        cpu_type = SystemHelper.cpu_type()
        page_size = SystemHelper.page_size()

        log.debug('CPU Type: %r', cpu_type)
        log.debug('Page Size: %r', page_size)

        if cpu_type:
            PathHelper.insert(libraries_path, system, architecture, cpu_type)

            if page_size:
                PathHelper.insert(libraries_path, system, architecture, '%s_%s' % (cpu_type, page_size))

        # UCS + CPU specific libraries
        if cpu_type and ucs:
            PathHelper.insert(libraries_path, system, architecture, cpu_type, ucs)

            if page_size:
                PathHelper.insert(libraries_path, system, architecture, '%s_%s' % (cpu_type, page_size), ucs)

        # Include attributes in error reports
        RAVEN.tags.update({
            'cpu.type': cpu_type,
            'memory.page_size': page_size,
            'python.ucs': ucs
        })

    @staticmethod
    def _insert_paths_windows(libraries_path, system, architecture):
        vcr = SystemHelper.vcr_version() or 'vc12'  # Assume "vc12" if call fails
        ucs = UNICODE_MAP.get(sys.maxunicode)

        log.debug('VCR: %r, UCS: %r', vcr, ucs)

        # VC++ libraries
        PathHelper.insert(libraries_path, system, architecture, vcr)

        # UCS libraries
        if ucs:
            PathHelper.insert(libraries_path, system, architecture, vcr, ucs)

        # Include attributes in error reports
        RAVEN.tags.update({
            'python.ucs': ucs,
            'vcr.version': vcr
        })


Push — develop ( de3ad7...3c2cc7 )

LibrariesManager._insert_paths() B

Complexity

Size

Duplication

Code Coverage

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1	1	from plugin.core.configuration import Configuration
		0 ignored issues – show Bug introduced 2016-03-25 06:15 UTC by Report Bug Copy Issue Report The name `configuration` does not seem to exist in module `plugin.core`. Loading history... Configuration introduced 2016-03-25 06:15 UTC by Report Bug Copy Issue Report Unable to import 'plugin.core.configuration' (invalid syntax (<string>, line 38)) This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
2	1	from plugin.core.environment import Environment
3	1	from plugin.core.helpers.variable import merge
4	1	from plugin.core.libraries.cache import CacheManager
5	1	from plugin.core.libraries.constants import CONTENTS_PATH, NATIVE_DIRECTORIES, UNICODE_MAP
6	1	from plugin.core.libraries.helpers import PathHelper, StorageHelper, SystemHelper
7	1	from plugin.core.libraries.tests import LIBRARY_TESTS
8	1	from plugin.core.logger.handlers.error_reporter import RAVEN
		0 ignored issues – show Bug introduced 2016-03-25 06:15 UTC by Report Bug Copy Issue Report The name `error_reporter` does not seem to exist in module `plugin.core.logger.handlers`. Loading history... Configuration introduced 2016-03-25 06:15 UTC by Report Bug Copy Issue Report Unable to import 'plugin.core.logger.handlers.error_reporter' (invalid syntax (<string>, line 133)) This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
9
10	1	import logging
11	1	import os
12	1	import platform
13	1	import sys
14
15	1	log = logging.getLogger(__name__)
16
17
18	1	class LibrariesManager(object):
19	1	@classmethod
20	1	def setup(cls, cache=False):
21		"""Setup native library directories
22
23		:param cache: Enable native library caching
24		:type cache: bool
25		"""
26
27		# Use `cache` value from advanced configuration
28	1	cache = Configuration.advanced['libraries'].get_boolean('cache', cache)
29
30		# Retrieve libraries path (and cache libraries, if enabled)
31	1	libraries_path = cls._libraries_path(cache)
32
33	1	if not libraries_path:
34		return
35
36	1	log.info('Using native libraries at %r', StorageHelper.to_relative_path(libraries_path))
37
38		# Remove current native library directories from `sys.path`
39	1	cls.reset()
40
41		# Insert platform specific library paths
42	1	cls._insert_paths(libraries_path)
43
44		# Display library paths in logfile
45	1	for path in sys.path:
46	1	path = os.path.abspath(path)
47
48	1	if StorageHelper.is_framework_path(path):
49		continue
50
51	1	log.info('[PATH] %s', StorageHelper.to_relative_path(path))
52
53	1	@staticmethod
54		def test():
55		"""Test native libraries to ensure they can be correctly loaded"""
56	1	log.info('Testing native library support...')
57
58	1	metadata = {}
59
60	1	for test in LIBRARY_TESTS:
61		# Run tests
62	1	result = test.run()
		0 ignored issues – show Bug introduced 2016-02-05 03:55 UTC by Report Bug Copy Issue Report The Class `PyOpenSSL` does not seem to have a member named `run`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history... Bug introduced 2016-02-05 03:55 UTC by Report Bug Copy Issue Report The Class `Apsw` does not seem to have a member named `run`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history... Bug introduced 2016-02-05 03:55 UTC by Report Bug Copy Issue Report The Class `Cryptography` does not seem to have a member named `run`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history... Bug introduced 2016-02-05 03:55 UTC by Report Bug Copy Issue Report The Class `LList` does not seem to have a member named `run`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
63
64	1	if not result.get('success'):
65		# Write message to logfile
66		log.error('%s: unavailable - %s', test.name, result.get('message'), exc_info=result.get('exc_info'))
67
68		if not test.optional:
69		return
70
71		continue
72
73		# Test successful
74	1	t_metadata = result.get('metadata') or {}
75	1	t_versions = t_metadata.get('versions')
76
77	1	if t_versions:
78	1	if len(t_versions) > 1:
79	1	log.info('%s: available (%s)', test.name, ', '.join([
80		'%s: %s' % (key, value)
81		for key, value in t_versions.items()
82		]))
83		else:
84	1	key = t_versions.keys()[0]
85
86	1	log.info('%s: available (%s)', test.name, t_versions[key])
87		else:
88	1	log.info('%s: available', test.name)
89
90		# Merge result into `metadata`
91	1	merge(metadata, t_metadata, recursive=True)
92
93		# Include versions in error reports
94	1	versions = metadata.get('versions') or {}
95
96	1	RAVEN.tags.update(dict([
97		('%s.version' % key, value)
98		for key, value in versions.items()
99		]))
100
101	1	@classmethod
102		def reset(cls):
103		"""Remove all the native library directives from `sys.path`"""
104
105	1	for path in sys.path:
106	1	path = os.path.abspath(path)
107
108	1	if not path.lower().startswith(CONTENTS_PATH.lower()):
109	1	continue
110
111		# Convert to relative path
112	1	path_rel = os.path.relpath(path, CONTENTS_PATH)
113
114		# Take the first two fragments
115	1	path_rel = os.path.sep.join(path_rel.split(os.path.sep)[:2])
116
117		# Convert to unix-style separators (/)
118	1	path_rel = path_rel.replace('\\', '/')
119
120		# Ignore non-native library directories
121	1	if path_rel not in NATIVE_DIRECTORIES:
122	1	continue
123
124		# Remove from `sys.path`
125		PathHelper.remove(path)
126
127	1	@classmethod
128	1	def _libraries_path(cls, cache=False):
129		"""Retrieve the native libraries base directory (and cache the libraries if enabled)
130
131		:param cache: Enable native library caching
132		:type cache: bool
133		"""
134
135		# Use specified libraries path (from "advanced.ini')
136	1	libraries_path = Configuration.advanced['libraries'].get('libraries_path')
137
138	1	if libraries_path and os.path.exists(libraries_path):
139		log.info('Using libraries at %r', StorageHelper.to_relative_path(libraries_path))
140		RAVEN.tags.update({'libraries.source': 'custom'})
141		return libraries_path
142
143		# Use system libraries (if bundled libraries have been disabled in "advanced.ini")
144	1	if not Configuration.advanced['libraries'].get_boolean('bundled', True):
145		log.info('Bundled libraries have been disabled, using system libraries')
146		RAVEN.tags.update({'libraries.source': 'system'})
147		return None
148
149		# Cache libraries (if enabled)
150	1	if cache:
151		RAVEN.tags.update({'libraries.source': 'cache'})
152		return cls._cache_libraries()
153
154	1	RAVEN.tags.update({'libraries.source': 'bundle'})
155	1	return Environment.path.libraries
156
157	1	@classmethod
158		def _cache_libraries(cls):
159		cache_path = Configuration.advanced['libraries'].get('cache_path')
160
161		# Try cache libraries to `cache_path`
162		libraries_path = CacheManager.sync(cache_path)
163
164		if not libraries_path:
165		log.info('Unable to cache libraries, using bundled libraries directly')
166		return Environment.path.libraries
167
168		log.info('Cached libraries to %r', StorageHelper.to_relative_path(libraries_path))
169		return libraries_path
170
171	1	@classmethod
172		def _insert_paths(cls, libraries_path):
173		# Display platform details
174	1	p_bits, _ = platform.architecture()
175	1	p_machine = platform.machine()
176
177	1	log.debug('Bits: %r, Machine: %r', p_bits, p_machine)
178
179		# Retrieve system details
180	1	system = SystemHelper.name()
181	1	architecture = SystemHelper.architecture()
182
183	1	if not architecture:
184		return
185
186	1	log.debug('System: %r, Architecture: %r', system, architecture)
187
188		# Insert architecture specific libraries
189	1	architectures = [architecture]
190
191	1	if architecture == 'i686':
192		# Fallback to i386
193		architectures.append('i386')
194
195	1	for arch in architectures + ['universal']:
196	1	cls._insert_architecture_paths(libraries_path, system, arch)
197
198	1	@classmethod
199		def _insert_architecture_paths(cls, libraries_path, system, architecture):
200	1	architecture_path = os.path.join(libraries_path, system, architecture)
201
202	1	if not os.path.exists(architecture_path):
203	1	return
204
205		# Architecture libraries
206	1	PathHelper.insert(libraries_path, system, architecture)
207
208		# System libraries
209	1	if system == 'Windows':
210		# Windows libraries (VC++ specific)
211		cls._insert_paths_windows(libraries_path, system, architecture)
212		else:
213		# Darwin/FreeBSD/Linux libraries
214	1	cls._insert_paths_unix(libraries_path, system, architecture)
215
216	1	@staticmethod
217		def _insert_paths_unix(libraries_path, system, architecture):
218		# UCS specific libraries
219	1	ucs = UNICODE_MAP.get(sys.maxunicode)
220	1	log.debug('UCS: %r', ucs)
221
222	1	if ucs:
223	1	PathHelper.insert(libraries_path, system, architecture, ucs)
224
225		# CPU specific libraries
226	1	cpu_type = SystemHelper.cpu_type()
227	1	page_size = SystemHelper.page_size()
228
229	1	log.debug('CPU Type: %r', cpu_type)
230	1	log.debug('Page Size: %r', page_size)
231
232	1	if cpu_type:
233		PathHelper.insert(libraries_path, system, architecture, cpu_type)
234
235		if page_size:
236		PathHelper.insert(libraries_path, system, architecture, '%s_%s' % (cpu_type, page_size))
237
238		# UCS + CPU specific libraries
239	1	if cpu_type and ucs:
240		PathHelper.insert(libraries_path, system, architecture, cpu_type, ucs)
241
242		if page_size:
243		PathHelper.insert(libraries_path, system, architecture, '%s_%s' % (cpu_type, page_size), ucs)
244
245		# Include attributes in error reports
246	1	RAVEN.tags.update({
247		'cpu.type': cpu_type,
248		'memory.page_size': page_size,
249		'python.ucs': ucs
250		})
251
252	1	@staticmethod
253		def _insert_paths_windows(libraries_path, system, architecture):
254		vcr = SystemHelper.vcr_version() or 'vc12' # Assume "vc12" if call fails
255		ucs = UNICODE_MAP.get(sys.maxunicode)
256
257		log.debug('VCR: %r, UCS: %r', vcr, ucs)
258
259		# VC++ libraries
260		PathHelper.insert(libraries_path, system, architecture, vcr)
261
262		# UCS libraries
263		if ucs:
264		PathHelper.insert(libraries_path, system, architecture, vcr, ucs)
265
266		# Include attributes in error reports
267		RAVEN.tags.update({
268		'python.ucs': ucs,
269		'vcr.version': vcr
270		})
271

fuzeman / Plex-Trakt-Scrobbler

Push — develop ( de3ad7...3c2cc7 )

LibrariesManager._insert_paths() B

Complexity

Size

Duplication

Code Coverage

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files

2. Missing init.py files