glances.plugins.Plugin.msg_curse() - Code Metrics - Inspection of "exports: riemann export implemented and documented" - nicolargo/glances - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#821)

unknown

created 2016-03-24 14:56 UTC

glances.plugins.Plugin.msg_curse() B

↳ Parent: glances.plugins.Plugin

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
cc	2
dl	0
loc	77
rs	8.9342

How to fix Long Method

# -*- coding: utf-8 -*-
#
# This file is part of Glances.
#
# Copyright (C) 2015 Nicolargo <[email protected]>
#
# 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/>.

"""
Help plugin.

Just a stupid plugin to display the help screen.
"""

from glances.globals import appname, psutil_version, version
from glances.plugins.glances_plugin import GlancesPlugin


class Plugin(GlancesPlugin):

    """Glances help plugin."""

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

        # Set the config instance
        self.config = config

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

        # init data dictionary
        self.view_data = {}
        self.generate_view_data()

    def update(self):
        """No stats. It is just a plugin to display the help."""
        pass

    def generate_view_data(self):
        self.view_data['version'] = '{0} {1}'.format(appname.title(), version)
        self.view_data['psutil_version'] = ' with PSutil {0}'.format(psutil_version)

        try:
            self.view_data['configuration_file'] = 'Configuration file: {0}'.format(self.config.loaded_config_file)
        except AttributeError:
            pass

        msg_col = ' {0:1}  {1:35}'
        msg_col2 = '   {0:1}  {1:35}'
        self.view_data['sort_auto'] = msg_col.format('a', 'Sort processes automatically')
        self.view_data['sort_network'] = msg_col2.format('b', 'Bytes or bits for network I/O')
        self.view_data['sort_cpu'] = msg_col.format('c', 'Sort processes by CPU%')
        self.view_data['show_hide_alert'] = msg_col2.format('l', 'Show/hide alert logs')
        self.view_data['sort_mem'] = msg_col.format('m', 'Sort processes by MEM%')
        self.view_data['sort_user'] = msg_col.format('u', 'Sort processes by USER')
        self.view_data['delete_warning_alerts'] = msg_col2.format('w', 'Delete warning alerts')
        self.view_data['sort_proc'] = msg_col.format('p', 'Sort processes by name')
        self.view_data['delete_warning_critical_alerts'] = msg_col2.format('x', 'Delete warning and critical alerts')
        self.view_data['sort_io'] = msg_col.format('i', 'Sort processes by I/O rate')
        self.view_data['percpu'] = msg_col2.format('1', 'Global CPU or per-CPU stats')
        self.view_data['sort_cpu_times'] = msg_col.format('t', 'Sort processes by TIME')
        self.view_data['show_hide_help'] = msg_col2.format('h', 'Show/hide this help screen')
        self.view_data['show_hide_diskio'] = msg_col.format('d', 'Show/hide disk I/O stats')
        self.view_data['view_network_io_combination'] = msg_col2.format('T', 'View network I/O as combination')
        self.view_data['show_hide_filesystem'] = msg_col.format('f', 'Show/hide filesystem stats')
        self.view_data['view_cumulative_network'] = msg_col2.format('U', 'View cumulative network I/O')
        self.view_data['show_hide_network'] = msg_col.format('n', 'Show/hide network stats')
        self.view_data['show_hide_filesytem_freespace'] = msg_col2.format('F', 'Show filesystem free space')
        self.view_data['show_hide_sensors'] = msg_col.format('s', 'Show/hide sensors stats')
        self.view_data['generate_graphs'] = msg_col2.format('g', 'Generate graphs for current history')
        self.view_data['show_hide_left_sidebar'] = msg_col.format('2', 'Show/hide left sidebar')
        self.view_data['reset_history'] = msg_col2.format('r', 'Reset history')
        self.view_data['enable_disable_process_stats'] = msg_col.format('z', 'Enable/disable processes stats')
        self.view_data['quit'] = msg_col2.format('q', 'Quit (Esc and Ctrl-C also work)')
        self.view_data['enable_disable_top_extends_stats'] = msg_col.format('e', 'Enable/disable top extended stats')
        self.view_data['enable_disable_short_processname'] = msg_col.format('/', 'Enable/disable short processes name')
        self.view_data['enable_disable_irix'] = msg_col.format('0', 'Enable/disable Irix process CPU')
        self.view_data['enable_disable_docker'] = msg_col2.format('D', 'Enable/disable Docker stats')
        self.view_data['enable_disable_quick_look'] = msg_col.format('3', 'Enable/disable quick look plugin')
        self.view_data['show_hide_ip'] = msg_col2.format('I', 'Show/hide IP module')
        self.view_data['diskio_iops'] = msg_col2.format('B', 'Count/rate for Disk I/O')
        self.view_data['show_hide_top_menu'] = msg_col2.format('5', 'Show/hide top menu (QL, CPU, MEM, SWAP and LOAD)')
        self.view_data['edit_pattern_filter'] = 'ENTER: Edit the process filter pattern'

    def get_view_data(self, args=None):
        return self.view_data

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

        # Build the string message
        # Header
        ret.append(self.curse_add_line(self.view_data['version'], 'TITLE'))
        ret.append(self.curse_add_line(self.view_data['psutil_version']))
        ret.append(self.curse_new_line())

        # Configuration file path
        if 'configuration_file' in self.view_data:
            ret.append(self.curse_new_line())
            ret.append(self.curse_add_line(self.view_data['configuration_file']))
            ret.append(self.curse_new_line())

        # Keys
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['sort_auto']))
        ret.append(self.curse_add_line(self.view_data['sort_network']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['sort_cpu']))
        ret.append(self.curse_add_line(self.view_data['show_hide_alert']))
        ret.append(self.curse_new_line())

        ret.append(self.curse_add_line(self.view_data['sort_mem']))
        ret.append(self.curse_add_line(self.view_data['delete_warning_alerts']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['sort_user']))
        ret.append(self.curse_add_line(self.view_data['delete_warning_critical_alerts']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['sort_proc']))
        ret.append(self.curse_add_line(self.view_data['percpu']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['sort_io']))
        ret.append(self.curse_add_line(self.view_data['show_hide_ip']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['sort_cpu_times']))
        ret.append(self.curse_add_line(self.view_data['enable_disable_docker']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['show_hide_diskio']))
        ret.append(self.curse_add_line(self.view_data['view_network_io_combination']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['show_hide_filesystem']))
        ret.append(self.curse_add_line(self.view_data['view_cumulative_network']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['show_hide_network']))
        ret.append(self.curse_add_line(self.view_data['show_hide_filesytem_freespace']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['show_hide_sensors']))
        ret.append(self.curse_add_line(self.view_data['generate_graphs']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['show_hide_left_sidebar']))
        ret.append(self.curse_add_line(self.view_data['reset_history']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['enable_disable_process_stats']))
        ret.append(self.curse_add_line(self.view_data['show_hide_help']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['enable_disable_quick_look']))
        ret.append(self.curse_add_line(self.view_data['diskio_iops']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['enable_disable_top_extends_stats']))
        ret.append(self.curse_add_line(self.view_data['show_hide_top_menu']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['enable_disable_short_processname']))
        ret.append(self.curse_new_line())
        ret.append(self.curse_add_line(self.view_data['enable_disable_irix']))
        ret.append(self.curse_add_line(self.view_data['quit']))
        ret.append(self.curse_new_line())

        ret.append(self.curse_new_line())

        ret.append(self.curse_add_line(self.view_data['edit_pattern_filter']))

        # Return the message with decoration
        return ret


1			# -- coding: utf-8 --
2			#
3			# This file is part of Glances.
4			#
5			# Copyright (C) 2015 Nicolargo <[email protected]>
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			"""
21			Help plugin.
22
23			Just a stupid plugin to display the help screen.
24			"""
25
26			from glances.globals import appname, psutil_version, version
27			from glances.plugins.glances_plugin import GlancesPlugin
28
29
30			class Plugin(GlancesPlugin):
31
32			"""Glances help plugin."""
33
34			def __init__(self, args=None, config=None):
35			"""Init the plugin."""
36			super(Plugin, self).__init__(args=args)
37
38			# Set the config instance
39			self.config = config
40
41			# We want to display the stat in the curse interface
42			self.display_curse = True
43
44			# init data dictionary
45			self.view_data = {}
46			self.generate_view_data()
47
48			def update(self):
49			"""No stats. It is just a plugin to display the help."""
50			pass
51
52			def generate_view_data(self):
53			self.view_data['version'] = '{0} {1}'.format(appname.title(), version)
54			self.view_data['psutil_version'] = ' with PSutil {0}'.format(psutil_version)
55
56			try:
57			self.view_data['configuration_file'] = 'Configuration file: {0}'.format(self.config.loaded_config_file)
58			except AttributeError:
59			pass
60
61			msg_col = ' {0:1} {1:35}'
62			msg_col2 = ' {0:1} {1:35}'
63			self.view_data['sort_auto'] = msg_col.format('a', 'Sort processes automatically')
64			self.view_data['sort_network'] = msg_col2.format('b', 'Bytes or bits for network I/O')
65			self.view_data['sort_cpu'] = msg_col.format('c', 'Sort processes by CPU%')
66			self.view_data['show_hide_alert'] = msg_col2.format('l', 'Show/hide alert logs')
67			self.view_data['sort_mem'] = msg_col.format('m', 'Sort processes by MEM%')
68			self.view_data['sort_user'] = msg_col.format('u', 'Sort processes by USER')
69			self.view_data['delete_warning_alerts'] = msg_col2.format('w', 'Delete warning alerts')
70			self.view_data['sort_proc'] = msg_col.format('p', 'Sort processes by name')
71			self.view_data['delete_warning_critical_alerts'] = msg_col2.format('x', 'Delete warning and critical alerts')
72			self.view_data['sort_io'] = msg_col.format('i', 'Sort processes by I/O rate')
73			self.view_data['percpu'] = msg_col2.format('1', 'Global CPU or per-CPU stats')
74			self.view_data['sort_cpu_times'] = msg_col.format('t', 'Sort processes by TIME')
75			self.view_data['show_hide_help'] = msg_col2.format('h', 'Show/hide this help screen')
76			self.view_data['show_hide_diskio'] = msg_col.format('d', 'Show/hide disk I/O stats')
77			self.view_data['view_network_io_combination'] = msg_col2.format('T', 'View network I/O as combination')
78			self.view_data['show_hide_filesystem'] = msg_col.format('f', 'Show/hide filesystem stats')
79			self.view_data['view_cumulative_network'] = msg_col2.format('U', 'View cumulative network I/O')
80			self.view_data['show_hide_network'] = msg_col.format('n', 'Show/hide network stats')
81			self.view_data['show_hide_filesytem_freespace'] = msg_col2.format('F', 'Show filesystem free space')
82			self.view_data['show_hide_sensors'] = msg_col.format('s', 'Show/hide sensors stats')
83			self.view_data['generate_graphs'] = msg_col2.format('g', 'Generate graphs for current history')
84			self.view_data['show_hide_left_sidebar'] = msg_col.format('2', 'Show/hide left sidebar')
85			self.view_data['reset_history'] = msg_col2.format('r', 'Reset history')
86			self.view_data['enable_disable_process_stats'] = msg_col.format('z', 'Enable/disable processes stats')
87			self.view_data['quit'] = msg_col2.format('q', 'Quit (Esc and Ctrl-C also work)')
88			self.view_data['enable_disable_top_extends_stats'] = msg_col.format('e', 'Enable/disable top extended stats')
89			self.view_data['enable_disable_short_processname'] = msg_col.format('/', 'Enable/disable short processes name')
90			self.view_data['enable_disable_irix'] = msg_col.format('0', 'Enable/disable Irix process CPU')
91			self.view_data['enable_disable_docker'] = msg_col2.format('D', 'Enable/disable Docker stats')
92			self.view_data['enable_disable_quick_look'] = msg_col.format('3', 'Enable/disable quick look plugin')
93			self.view_data['show_hide_ip'] = msg_col2.format('I', 'Show/hide IP module')
94			self.view_data['diskio_iops'] = msg_col2.format('B', 'Count/rate for Disk I/O')
95			self.view_data['show_hide_top_menu'] = msg_col2.format('5', 'Show/hide top menu (QL, CPU, MEM, SWAP and LOAD)')
96			self.view_data['edit_pattern_filter'] = 'ENTER: Edit the process filter pattern'
97
98			def get_view_data(self, args=None):
99			return self.view_data
100
101			def msg_curse(self, args=None):
102			"""Return the list to display in the curse interface."""
103			# Init the return message
104			ret = []
105
106			# Build the string message
107			# Header
108			ret.append(self.curse_add_line(self.view_data['version'], 'TITLE'))
109			ret.append(self.curse_add_line(self.view_data['psutil_version']))
110			ret.append(self.curse_new_line())
111
112			# Configuration file path
113			if 'configuration_file' in self.view_data:
114			ret.append(self.curse_new_line())
115			ret.append(self.curse_add_line(self.view_data['configuration_file']))
116			ret.append(self.curse_new_line())
117
118			# Keys
119			ret.append(self.curse_new_line())
120			ret.append(self.curse_add_line(self.view_data['sort_auto']))
121			ret.append(self.curse_add_line(self.view_data['sort_network']))
122			ret.append(self.curse_new_line())
123			ret.append(self.curse_add_line(self.view_data['sort_cpu']))
124			ret.append(self.curse_add_line(self.view_data['show_hide_alert']))
125			ret.append(self.curse_new_line())
126
127			ret.append(self.curse_add_line(self.view_data['sort_mem']))
128			ret.append(self.curse_add_line(self.view_data['delete_warning_alerts']))
129			ret.append(self.curse_new_line())
130			ret.append(self.curse_add_line(self.view_data['sort_user']))
131			ret.append(self.curse_add_line(self.view_data['delete_warning_critical_alerts']))
132			ret.append(self.curse_new_line())
133			ret.append(self.curse_add_line(self.view_data['sort_proc']))
134			ret.append(self.curse_add_line(self.view_data['percpu']))
135			ret.append(self.curse_new_line())
136			ret.append(self.curse_add_line(self.view_data['sort_io']))
137			ret.append(self.curse_add_line(self.view_data['show_hide_ip']))
138			ret.append(self.curse_new_line())
139			ret.append(self.curse_add_line(self.view_data['sort_cpu_times']))
140			ret.append(self.curse_add_line(self.view_data['enable_disable_docker']))
141			ret.append(self.curse_new_line())
142			ret.append(self.curse_add_line(self.view_data['show_hide_diskio']))
143			ret.append(self.curse_add_line(self.view_data['view_network_io_combination']))
144			ret.append(self.curse_new_line())
145			ret.append(self.curse_add_line(self.view_data['show_hide_filesystem']))
146			ret.append(self.curse_add_line(self.view_data['view_cumulative_network']))
147			ret.append(self.curse_new_line())
148			ret.append(self.curse_add_line(self.view_data['show_hide_network']))
149			ret.append(self.curse_add_line(self.view_data['show_hide_filesytem_freespace']))
150			ret.append(self.curse_new_line())
151			ret.append(self.curse_add_line(self.view_data['show_hide_sensors']))
152			ret.append(self.curse_add_line(self.view_data['generate_graphs']))
153			ret.append(self.curse_new_line())
154			ret.append(self.curse_add_line(self.view_data['show_hide_left_sidebar']))
155			ret.append(self.curse_add_line(self.view_data['reset_history']))
156			ret.append(self.curse_new_line())
157			ret.append(self.curse_add_line(self.view_data['enable_disable_process_stats']))
158			ret.append(self.curse_add_line(self.view_data['show_hide_help']))
159			ret.append(self.curse_new_line())
160			ret.append(self.curse_add_line(self.view_data['enable_disable_quick_look']))
161			ret.append(self.curse_add_line(self.view_data['diskio_iops']))
162			ret.append(self.curse_new_line())
163			ret.append(self.curse_add_line(self.view_data['enable_disable_top_extends_stats']))
164			ret.append(self.curse_add_line(self.view_data['show_hide_top_menu']))
165			ret.append(self.curse_new_line())
166			ret.append(self.curse_add_line(self.view_data['enable_disable_short_processname']))
167			ret.append(self.curse_new_line())
168			ret.append(self.curse_add_line(self.view_data['enable_disable_irix']))
169			ret.append(self.curse_add_line(self.view_data['quit']))
170			ret.append(self.curse_new_line())
171
172			ret.append(self.curse_new_line())
173
174			ret.append(self.curse_add_line(self.view_data['edit_pattern_filter']))
175
176			# Return the message with decoration
177			return ret
178

nicolargo / glances

Pull Request — master (#821)

glances.plugins.Plugin.msg_curse() B

Complexity

Size

Duplication

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like