2042

pending completion

Build # 2042

Build Type

Pull #963

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/nicolargo/glances/commit/<a class=hub.com/nicolargo/glances/commit/f4e047fa965d315c816bc874f7388e9f3631949e">f4e047fa9<a href="https://github.com/nicolargo/glances/commit/f4e047fa965d315c816bc874f7388e9f3631949e">&quot;&gt;Revert &amp;quot;First step of curses catch_key method refactor&quot;

This reverts commit </a><a class="double-link" href="https://github.com/nicolargo/glances/commit/<a class="double-link" href="https://github.com/nicolargo/glances/commit/f88e546edcb3f59d0fb47efc95574e683e02348e">f88e546ed</a>">f88e546ed</a><a href="https://github.com/nicolargo/glances/commit/f4e047fa965d315c816bc874f7388e9f3631949e">.

Pull Request Pull Request #963: Develop

Run Details

424 of 424 new or added lines in 36 files covered. (100.0%)

1907 of 5186 relevant lines covered (36.77%)

1.1 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

50.37

/glances/plugins/glances_sensors.py

# -*- coding: utf-8 -*-
#
# This file is part of Glances.
#
# Copyright (C) 2015 Nicolargo <nicolas@nicolargo.com>
#
# Glances is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Glances is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

"""Sensors plugin."""

# Sensors library (optional; Linux-only)
# Py3Sensors: https://bitbucket.org/gleb_zhulik/py3sensors
try:
    import sensors
except ImportError:
    pass

from glances.logger import logger
from glances.plugins.glances_batpercent import Plugin as BatPercentPlugin
from glances.plugins.glances_hddtemp import Plugin as HddTempPlugin
from glances.plugins.glances_plugin import GlancesPlugin

SENSOR_TEMP_UNIT = 'C'
SENSOR_FAN_UNIT = 'rpm'


def to_fahrenheit(celsius):
    """Convert Celsius to Fahrenheit."""
    return celsius * 1.8 + 32


class Plugin(GlancesPlugin):

    """Glances sensors plugin.

    The stats list includes both sensors and hard disks stats, if any.
    The sensors are already grouped by chip type and then sorted by name.
    The hard disks are already sorted by name.
    """

    def __init__(self, args=None):
        """Init the plugin."""
        super(Plugin, self).__init__(args=args)

        # Init the sensor class
        self.glancesgrabsensors = GlancesGrabSensors()

        # Instance for the HDDTemp Plugin in order to display the hard disks
        # temperatures
        self.hddtemp_plugin = HddTempPlugin(args=args)

        # Instance for the BatPercent in order to display the batteries
        # capacities
        self.batpercent_plugin = BatPercentPlugin(args=args)

        # We want to display the stat in the curse interface
        self.display_curse = True

        # Init the stats
        self.reset()

    def get_key(self):
        """Return the key of the list."""
        return 'label'

    def reset(self):
        """Reset/init the stats."""
        self.stats = []

    @GlancesPlugin._check_decorator
    @GlancesPlugin._log_result_decorator
    def update(self):
        """Update sensors stats using the input method."""
        # Reset the stats
        self.reset()

        if self.input_method == 'local':
            # Update stats using the dedicated lib
            self.stats = []
            # Get the temperature
            try:
                temperature = self.__set_type(self.glancesgrabsensors.get('temperature_core'),
                                              'temperature_core')
            except Exception as e:
                logger.error("Cannot grab sensors temperatures (%s)" % e)
            else:
                # Append temperature
                self.stats.extend(temperature)
            # Get the FAN speed
            try:
                fan_speed = self.__set_type(self.glancesgrabsensors.get('fan_speed'),
                                            'fan_speed')
            except Exception as e:
                logger.error("Cannot grab FAN speed (%s)" % e)
            else:
                # Append FAN speed
                self.stats.extend(fan_speed)
            # Update HDDtemp stats
            try:
                hddtemp = self.__set_type(self.hddtemp_plugin.update(),
                                          'temperature_hdd')
            except Exception as e:
                logger.error("Cannot grab HDD temperature (%s)" % e)
            else:
                # Append HDD temperature
                self.stats.extend(hddtemp)
            # Update batteries stats
            try:
                batpercent = self.__set_type(self.batpercent_plugin.update(),
                                             'battery')
            except Exception as e:
                logger.error("Cannot grab battery percent (%s)" % e)
            else:
                # Append Batteries %
                self.stats.extend(batpercent)

        elif self.input_method == 'snmp':
            # Update stats using SNMP
            # No standard:
            # http://www.net-snmp.org/wiki/index.php/Net-SNMP_and_lm-sensors_on_Ubuntu_10.04

            pass

        return self.stats

    def __set_type(self, stats, sensor_type):
        """Set the plugin type.

        4 types of stats is possible in the sensors plugin:
        - Core temperature: 'temperature_core'
        - Fan speed: 'fan_speed'
        - HDD temperature: 'temperature_hdd'
        - Battery capacity: 'battery'
        """
        for i in stats:
            # Set the sensors type
            i.update({'type': sensor_type})
            # also add the key name
            i.update({'key': self.get_key()})

        return stats

    def update_views(self):
        """Update stats views."""
        # Call the father's method
        super(Plugin, self).update_views()

        # Add specifics informations
        # Alert
        for i in self.stats:
            if not i['value']:
                continue
            if i['type'] == 'battery':
                self.views[i[self.get_key()]]['value']['decoration'] = self.get_alert(100 - i['value'], header=i['type'])
            else:
                self.views[i[self.get_key()]]['value']['decoration'] = self.get_alert(i['value'], header=i['type'])

    def msg_curse(self, args=None):
        """Return the dict to display in the curse interface."""
        # Init the return message
        ret = []

        # Only process if stats exist and display plugin enable...
        if not self.stats or args.disable_sensors:
            return ret

        # Build the string message
        # Header
        msg = '{:18}'.format('SENSORS')
        ret.append(self.curse_add_line(msg, "TITLE"))

        for i in self.stats:
            # Do not display anything if no battery are detected
            if (i['type'] == 'battery' and i['value'] == []):
                continue
            # New line
            ret.append(self.curse_new_line())
            # Alias for the lable name ?
            label = self.has_alias(i['label'].lower())
            if label is None:
                label = i['label']
            if i['type'] != 'fan_speed':
                msg = '{:15}'.format(label[:15])
            else:
                msg = '{:13}'.format(label[:13])
            ret.append(self.curse_add_line(msg))
            if i['value'] in (b'ERR', b'SLP', b'UNK', b'NOS'):
                msg = '{:>8}'.format(i['value'])
                ret.append(self.curse_add_line(
                    msg, self.get_views(item=i[self.get_key()],
                                        key='value',
                                        option='decoration')))
            else:
                if (args.fahrenheit and i['type'] != 'battery' and
                        i['type'] != 'fan_speed'):
                    value = to_fahrenheit(i['value'])
                    unit = 'F'
                else:
                    value = i['value']
                    unit = i['unit']
                try:
                    msg = '{:>7.0f}{}'.format(value, unit)
                    ret.append(self.curse_add_line(
                        msg, self.get_views(item=i[self.get_key()],
                                            key='value',
                                            option='decoration')))
                except (TypeError, ValueError):
                    pass

        return ret


class GlancesGrabSensors(object):

    """Get sensors stats using the py3sensors library."""

    def __init__(self):
        """Init sensors stats."""
        try:
            sensors.init()
        except Exception:
            self.initok = False
        else:
            self.initok = True

        # Init the stats
        self.reset()

    def reset(self):
        """Reset/init the stats."""
        self.sensors_list = []

    def __update__(self):
        """Update the stats."""
        # Reset the list
        self.reset()

        if self.initok:
            for chip in sensors.iter_detected_chips():
                for feature in chip:
                    sensors_current = {}
                    if feature.name.startswith(b'temp'):
                        # Temperature sensor
                        sensors_current['unit'] = SENSOR_TEMP_UNIT
                    elif feature.name.startswith(b'fan'):
                        # Fan speed sensor
                        sensors_current['unit'] = SENSOR_FAN_UNIT
                    if sensors_current:
                        try:
                            sensors_current['label'] = feature.label
                            sensors_current['value'] = int(feature.get_value())
                        except Exception as e:
                            logger.debug("Cannot grab sensor stat (%s)" % e)
                        else:
                            self.sensors_list.append(sensors_current)

        return self.sensors_list

    def get(self, sensor_type='temperature_core'):
        """Get sensors list."""
        self.__update__()
        if sensor_type == 'temperature_core':
            ret = [s for s in self.sensors_list if s['unit'] == SENSOR_TEMP_UNIT]
        elif sensor_type == 'fan_speed':
            ret = [s for s in self.sensors_list if s['unit'] == SENSOR_FAN_UNIT]
        else:
            # Unknown type
            logger.debug("Unknown sensor type %s" % sensor_type)
            ret = []
        return ret

    def quit(self):
        """End of connection."""
        if self.initok:
            sensors.cleanup()

1	# -- coding: utf-8 --
2	#
3	# This file is part of Glances.
4	#
5	# Copyright (C) 2015 Nicolargo <nicolas@nicolargo.com>
6	#
7	# Glances is free software; you can redistribute it and/or modify
8	# it under the terms of the GNU Lesser General Public License as published by
9	# the Free Software Foundation, either version 3 of the License, or
10	# (at your option) any later version.
11	#
12	# Glances is distributed in the hope that it will be useful,
13	# but WITHOUT ANY WARRANTY; without even the implied warranty of
14	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15	# GNU Lesser General Public License for more details.
16	#
17	# You should have received a copy of the GNU Lesser General Public License
18	# along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20	"""Sensors plugin."""	3✔
21
22	# Sensors library (optional; Linux-only)
23	# Py3Sensors: https://bitbucket.org/gleb_zhulik/py3sensors
24	try:	3✔
25	import sensors	3✔
26	except ImportError:
27	pass
28
29	from glances.logger import logger	3✔
30	from glances.plugins.glances_batpercent import Plugin as BatPercentPlugin	3✔
31	from glances.plugins.glances_hddtemp import Plugin as HddTempPlugin	3✔
32	from glances.plugins.glances_plugin import GlancesPlugin	3✔
33
34	SENSOR_TEMP_UNIT = 'C'	3✔
35	SENSOR_FAN_UNIT = 'rpm'	3✔
36
37
38	def to_fahrenheit(celsius):	3✔
39	"""Convert Celsius to Fahrenheit."""
40	return celsius * 1.8 + 32	×
41
42
43	class Plugin(GlancesPlugin):	3✔
44
45	"""Glances sensors plugin.
46
47	The stats list includes both sensors and hard disks stats, if any.
48	The sensors are already grouped by chip type and then sorted by name.
49	The hard disks are already sorted by name.
50	"""
51
52	def __init__(self, args=None):	3✔
53	"""Init the plugin."""
54	super(Plugin, self).__init__(args=args)	3✔
55
56	# Init the sensor class
57	self.glancesgrabsensors = GlancesGrabSensors()	3✔
58
59	# Instance for the HDDTemp Plugin in order to display the hard disks
60	# temperatures
61	self.hddtemp_plugin = HddTempPlugin(args=args)	3✔
62
63	# Instance for the BatPercent in order to display the batteries
64	# capacities
65	self.batpercent_plugin = BatPercentPlugin(args=args)	3✔
66
67	# We want to display the stat in the curse interface
68	self.display_curse = True	3✔
69
70	# Init the stats
71	self.reset()	3✔
72
73	def get_key(self):	3✔
74	"""Return the key of the list."""
75	return 'label'	3✔
76
77	def reset(self):	3✔
78	"""Reset/init the stats."""
79	self.stats = []	3✔
80
81	@GlancesPlugin._check_decorator	3✔
82	@GlancesPlugin._log_result_decorator	3✔
83	def update(self):
84	"""Update sensors stats using the input method."""
85	# Reset the stats
86	self.reset()	3✔
87
88	if self.input_method == 'local':	3✔
89	# Update stats using the dedicated lib
90	self.stats = []	3✔
91	# Get the temperature
92	try:	3✔
93	temperature = self.__set_type(self.glancesgrabsensors.get('temperature_core'),	3✔
94	'temperature_core')
95	except Exception as e:	×
96	logger.error("Cannot grab sensors temperatures (%s)" % e)	×
97	else:
98	# Append temperature
99	self.stats.extend(temperature)	3✔
100	# Get the FAN speed
101	try:	3✔
102	fan_speed = self.__set_type(self.glancesgrabsensors.get('fan_speed'),	3✔
103	'fan_speed')
104	except Exception as e:	×
105	logger.error("Cannot grab FAN speed (%s)" % e)	×
106	else:
107	# Append FAN speed
108	self.stats.extend(fan_speed)	3✔
109	# Update HDDtemp stats
110	try:	3✔
111	hddtemp = self.__set_type(self.hddtemp_plugin.update(),	3✔
112	'temperature_hdd')
113	except Exception as e:	×
114	logger.error("Cannot grab HDD temperature (%s)" % e)	×
115	else:
116	# Append HDD temperature
117	self.stats.extend(hddtemp)	3✔
118	# Update batteries stats
119	try:	3✔
120	batpercent = self.__set_type(self.batpercent_plugin.update(),	3✔
121	'battery')
122	except Exception as e:	×
123	logger.error("Cannot grab battery percent (%s)" % e)	×
124	else:
125	# Append Batteries %
126	self.stats.extend(batpercent)	3✔
127
128	elif self.input_method == 'snmp':	×
129	# Update stats using SNMP
130	# No standard:
131	# http://www.net-snmp.org/wiki/index.php/Net-SNMP_and_lm-sensors_on_Ubuntu_10.04
132
133	pass	×
134
135	return self.stats	3✔
136
137	def __set_type(self, stats, sensor_type):	3✔
138	"""Set the plugin type.
139
140	4 types of stats is possible in the sensors plugin:
141	- Core temperature: 'temperature_core'
142	- Fan speed: 'fan_speed'
143	- HDD temperature: 'temperature_hdd'
144	- Battery capacity: 'battery'
145	"""
146	for i in stats:	3✔
147	# Set the sensors type
148	i.update({'type': sensor_type})	×
149	# also add the key name
150	i.update({'key': self.get_key()})	×
151
152	return stats	3✔
153
154	def update_views(self):	3✔
155	"""Update stats views."""
156	# Call the father's method
157	super(Plugin, self).update_views()	3✔
158
159	# Add specifics informations
160	# Alert
161	for i in self.stats:	3✔
162	if not i['value']:	×
163	continue	×
164	if i['type'] == 'battery':	×
165	self.views[i[self.get_key()]]['value']['decoration'] = self.get_alert(100 - i['value'], header=i['type'])	×
166	else:
167	self.views[i[self.get_key()]]['value']['decoration'] = self.get_alert(i['value'], header=i['type'])	×
168
169	def msg_curse(self, args=None):	3✔
170	"""Return the dict to display in the curse interface."""
171	# Init the return message
172	ret = []	×
173
174	# Only process if stats exist and display plugin enable...
175	if not self.stats or args.disable_sensors:	×
176	return ret	×
177
178	# Build the string message
179	# Header
180	msg = '{:18}'.format('SENSORS')	×
181	ret.append(self.curse_add_line(msg, "TITLE"))	×
182
183	for i in self.stats:	×
184	# Do not display anything if no battery are detected
185	if (i['type'] == 'battery' and i['value'] == []):	×
186	continue	×
187	# New line
188	ret.append(self.curse_new_line())	×
189	# Alias for the lable name ?
190	label = self.has_alias(i['label'].lower())	×
191	if label is None:	×
192	label = i['label']	×
193	if i['type'] != 'fan_speed':	×
194	msg = '{:15}'.format(label[:15])	×
195	else:
196	msg = '{:13}'.format(label[:13])	×
197	ret.append(self.curse_add_line(msg))	×
198	if i['value'] in (b'ERR', b'SLP', b'UNK', b'NOS'):	×
199	msg = '{:>8}'.format(i['value'])	×
200	ret.append(self.curse_add_line(	×
201	msg, self.get_views(item=i[self.get_key()],
202	key='value',
203	option='decoration')))
204	else:
205	if (args.fahrenheit and i['type'] != 'battery' and	×
206	i['type'] != 'fan_speed'):
207	value = to_fahrenheit(i['value'])	×
208	unit = 'F'	×
209	else:
210	value = i['value']	×
211	unit = i['unit']	×
212	try:	×
213	msg = '{:>7.0f}{}'.format(value, unit)	×
214	ret.append(self.curse_add_line(	×
215	msg, self.get_views(item=i[self.get_key()],
216	key='value',
217	option='decoration')))
218	except (TypeError, ValueError):	×
219	pass	×
220
221	return ret	×
222
223
224	class GlancesGrabSensors(object):	3✔
225
226	"""Get sensors stats using the py3sensors library."""
227
228	def __init__(self):	3✔
229	"""Init sensors stats."""
230	try:	3✔
231	sensors.init()	3✔
232	except Exception:	3✔
233	self.initok = False	3✔
234	else:
235	self.initok = True	×
236
237	# Init the stats
238	self.reset()	3✔
239
240	def reset(self):	3✔
241	"""Reset/init the stats."""
242	self.sensors_list = []	3✔
243
244	def __update__(self):	3✔
245	"""Update the stats."""
246	# Reset the list
247	self.reset()	3✔
248
249	if self.initok:	3✔
250	for chip in sensors.iter_detected_chips():	×
251	for feature in chip:	×
252	sensors_current = {}	×
253	if feature.name.startswith(b'temp'):	×
254	# Temperature sensor
255	sensors_current['unit'] = SENSOR_TEMP_UNIT	×
256	elif feature.name.startswith(b'fan'):	×
257	# Fan speed sensor
258	sensors_current['unit'] = SENSOR_FAN_UNIT	×
259	if sensors_current:	×
260	try:	×
261	sensors_current['label'] = feature.label	×
262	sensors_current['value'] = int(feature.get_value())	×
263	except Exception as e:	×
264	logger.debug("Cannot grab sensor stat (%s)" % e)	×
265	else:
266	self.sensors_list.append(sensors_current)	×
267
268	return self.sensors_list	3✔
269
270	def get(self, sensor_type='temperature_core'):	3✔
271	"""Get sensors list."""
272	self.__update__()	3✔
273	if sensor_type == 'temperature_core':	3✔
274	ret = [s for s in self.sensors_list if s['unit'] == SENSOR_TEMP_UNIT]	3✔
275	elif sensor_type == 'fan_speed':	3✔
276	ret = [s for s in self.sensors_list if s['unit'] == SENSOR_FAN_UNIT]	3✔
277	else:
278	# Unknown type
279	logger.debug("Unknown sensor type %s" % sensor_type)	×
280	ret = []	×
281	return ret	3✔
282
283	def quit(self):	3✔
284	"""End of connection."""
285	if self.initok:	×
286	sensors.cleanup()	×

nicolargo / glances / 2042

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous