glances.client_browser.GlancesClientBrowser.__display_server() - Code Metrics - Inspection of "version 4.3.0" - nicolargo/glances - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( ce0fc3...e09530 )

by Nicolas

created 2024-12-27 14:16 UTC

GlancesClientBrowser.__display_server() C

↳ Parent: glances.client_browser

Complexity

Conditions

Size

Total Lines	76
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	38
nop	2
dl	0
loc	76
rs	5.9999
c	0
b	0
f	0

How to fix Long Method Complexity

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

If many parameters/temporary variables are present:
- Replace temporary variables with Query
- Introduce parameter object; often combined with preserve whole object
- If the above two are insufficient: Replace method with method object
If you have long conditionals: Decompose Conditional
Otherwise: Extract method

Complexity

Complex classes like glances.client_browser.GlancesClientBrowser.__display_server() often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

#
# This file is part of Glances.
#
# SPDX-FileCopyrightText: 2024 Nicolas Hennion <[email protected]>
#
# SPDX-License-Identifier: LGPL-3.0-only
#

"""Manage the Glances client browser (list of Glances server)."""

import webbrowser

from glances.client import GlancesClient
from glances.logger import LOG_FILENAME, logger
from glances.outputs.glances_curses_browser import GlancesCursesBrowser
from glances.servers_list import GlancesServersList


class GlancesClientBrowser:
    """This class creates and manages the TCP client browser (servers list)."""

    def __init__(self, config=None, args=None):
        # Store the arg/config
        self.args = args
        self.config = config

        # Init the server list
        self.servers_list = GlancesServersList(config=config, args=args)

        # Init screen
        self.screen = GlancesCursesBrowser(args=self.args)

    def __display_server(self, server):
        """Connect and display the given server"""
        # Display the Glances client for the selected server
        logger.debug(f"Selected server {server}")

        if server['protocol'].lower() == 'rest':
            # Display a popup
            self.screen.display_popup(
                'Open the WebUI {}:{} in a Web Browser'.format(server['name'], server['port']), duration=1
            )
            # Try to open a Webbrowser
            webbrowser.open(self.servers_list.get_uri(server), new=2, autoraise=1)
            self.screen.active_server = None
            return

        # Connection can take time
        # Display a popup
        self.screen.display_popup('Connect to {}:{}'.format(server['name'], server['port']), duration=1)

        # A password is needed to access to the server's stats
        if server['password'] is None:
            # First of all, check if a password is available in the [passwords] section
            clear_password = self.servers_list.password.get_password(server['name'])
            if (
                clear_password is None
                or self.servers_list.get_servers_list()[self.screen.active_server]['status'] == 'PROTECTED'
            ):
                # Else, the password should be enter by the user
                # Display a popup to enter password
                clear_password = self.screen.display_popup(
                    'Password needed for {}: '.format(server['name']), popup_type='input', is_password=True
                )
            # Store the password for the selected server
            if clear_password is not None:
                self.set_in_selected('password', self.servers_list.password.get_hash(clear_password))

        # Display the Glance client on the selected server
        logger.info("Connect Glances client to the {} server".format(server['key']))

        # Init the client
        args_server = self.args

        # Overwrite connection setting
        args_server.client = server['ip']
        args_server.port = server['port']
        args_server.username = server['username']
        args_server.password = server['password']
        client = GlancesClient(config=self.config, args=args_server, return_to_browser=True)

        # Test if client and server are in the same major version
        if not client.login():
            self.screen.display_popup(
                "Sorry, cannot connect to '{}'\n" "See '{}' for more details".format(server['name'], LOG_FILENAME)
            )

            # Set the ONLINE status for the selected server
            self.set_in_selected('status', 'OFFLINE')
        else:
            # Start the client loop
            # Return connection type: 'glances' or 'snmp'
            connection_type = client.serve_forever()

            try:
                logger.debug("Disconnect Glances client from the {} server".format(server['key']))
            except IndexError:
                # Server did not exist anymore
                pass
            else:
                # Set the ONLINE status for the selected server
                if connection_type == 'snmp':
                    self.set_in_selected('status', 'SNMP')
                else:
                    self.set_in_selected('status', 'ONLINE')

        # Return to the browser (no server selected)
        self.screen.active_server = None

    def __serve_forever(self):
        """Main client loop."""
        # No need to update the server list
        while not self.screen.is_end:
            # Update the stats in the servers list
            self.servers_list.update_servers_stats()

            if self.screen.active_server is None:
                # Display Glances browser (servers list)
                self.screen.update(self.servers_list.get_servers_list())
            else:
                # Display selected Glances server
                self.__display_server(self.servers_list.get_servers_list()[self.screen.active_server])

    def serve_forever(self):
        """Wrapper to the serve_forever function.

        This function will restore the terminal to a sane state
        before re-raising the exception and generating a traceback.
        """
        try:
            return self.__serve_forever()
        finally:
            self.end()

    def set_in_selected(self, key, value):
        """Set the (key, value) for the selected server in the list."""
        self.servers_list.set_in_selected(self.screen.active_server, key, value)

    def end(self):
        """End of the client browser session."""
        self.screen.end()


1			#
2			# This file is part of Glances.
3			#
4			# SPDX-FileCopyrightText: 2024 Nicolas Hennion <[email protected]>
5			#
6			# SPDX-License-Identifier: LGPL-3.0-only
7			#
8
9			"""Manage the Glances client browser (list of Glances server)."""
10
11			import webbrowser
12
13			from glances.client import GlancesClient
14			from glances.logger import LOG_FILENAME, logger
15			from glances.outputs.glances_curses_browser import GlancesCursesBrowser
16			from glances.servers_list import GlancesServersList
17
18
19			class GlancesClientBrowser:
20			"""This class creates and manages the TCP client browser (servers list)."""
21
22			def __init__(self, config=None, args=None):
23			# Store the arg/config
24			self.args = args
25			self.config = config
26
27			# Init the server list
28			self.servers_list = GlancesServersList(config=config, args=args)
29
30			# Init screen
31			self.screen = GlancesCursesBrowser(args=self.args)
32
33			def __display_server(self, server):
34			"""Connect and display the given server"""
35			# Display the Glances client for the selected server
36			logger.debug(f"Selected server {server}")
37
38			if server['protocol'].lower() == 'rest':
39			# Display a popup
40			self.screen.display_popup(
41			'Open the WebUI {}:{} in a Web Browser'.format(server['name'], server['port']), duration=1
42			)
43			# Try to open a Webbrowser
44			webbrowser.open(self.servers_list.get_uri(server), new=2, autoraise=1)
45			self.screen.active_server = None
46			return
47
48			# Connection can take time
49			# Display a popup
50			self.screen.display_popup('Connect to {}:{}'.format(server['name'], server['port']), duration=1)
51
52			# A password is needed to access to the server's stats
53			if server['password'] is None:
54			# First of all, check if a password is available in the [passwords] section
55			clear_password = self.servers_list.password.get_password(server['name'])
56			if (
57			clear_password is None
58			or self.servers_list.get_servers_list()[self.screen.active_server]['status'] == 'PROTECTED'
59			):
60			# Else, the password should be enter by the user
61			# Display a popup to enter password
62			clear_password = self.screen.display_popup(
63			'Password needed for {}: '.format(server['name']), popup_type='input', is_password=True
64			)
65			# Store the password for the selected server
66			if clear_password is not None:
67			self.set_in_selected('password', self.servers_list.password.get_hash(clear_password))
68
69			# Display the Glance client on the selected server
70			logger.info("Connect Glances client to the {} server".format(server['key']))
71
72			# Init the client
73			args_server = self.args
74
75			# Overwrite connection setting
76			args_server.client = server['ip']
77			args_server.port = server['port']
78			args_server.username = server['username']
79			args_server.password = server['password']
80			client = GlancesClient(config=self.config, args=args_server, return_to_browser=True)
81
82			# Test if client and server are in the same major version
83			if not client.login():
84			self.screen.display_popup(
85			"Sorry, cannot connect to '{}'\n" "See '{}' for more details".format(server['name'], LOG_FILENAME)
86			)
87
88			# Set the ONLINE status for the selected server
89			self.set_in_selected('status', 'OFFLINE')
90			else:
91			# Start the client loop
92			# Return connection type: 'glances' or 'snmp'
93			connection_type = client.serve_forever()
94
95			try:
96			logger.debug("Disconnect Glances client from the {} server".format(server['key']))
97			except IndexError:
98			# Server did not exist anymore
99			pass
100			else:
101			# Set the ONLINE status for the selected server
102			if connection_type == 'snmp':
103			self.set_in_selected('status', 'SNMP')
104			else:
105			self.set_in_selected('status', 'ONLINE')
106
107			# Return to the browser (no server selected)
108			self.screen.active_server = None
109
110			def __serve_forever(self):
111			"""Main client loop."""
112			# No need to update the server list
113			while not self.screen.is_end:
114			# Update the stats in the servers list
115			self.servers_list.update_servers_stats()
116
117			if self.screen.active_server is None:
118			# Display Glances browser (servers list)
119			self.screen.update(self.servers_list.get_servers_list())
120			else:
121			# Display selected Glances server
122			self.__display_server(self.servers_list.get_servers_list()[self.screen.active_server])
123
124			def serve_forever(self):
125			"""Wrapper to the serve_forever function.
126
127			This function will restore the terminal to a sane state
128			before re-raising the exception and generating a traceback.
129			"""
130			try:
131			return self.__serve_forever()
132			finally:
133			self.end()
134
135			def set_in_selected(self, key, value):
136			"""Set the (key, value) for the selected server in the list."""
137			self.servers_list.set_in_selected(self.screen.active_server, key, value)
138
139			def end(self):
140			"""End of the client browser session."""
141			self.screen.end()
142

nicolargo / glances

Push — master ( ce0fc3...e09530 )

GlancesClientBrowser.__display_server() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Complexity

Duplication Side-by-Side

Filter issues like