nicolargo / glances

glances/__init__.py

# -*- coding: utf-8 -*-
#
# This file is part of Glances.
#
# Copyright (C) 2020 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/>.
#

"""Init the Glances software."""

# Import system libs
import locale

import missing from __future__ import absolute_import

import platform

import missing from __future__ import absolute_import

import signal

import missing from __future__ import absolute_import

import sys

import missing from __future__ import absolute_import

# Global name
# Version should start and end with a numerical char
# See https://packaging.python.org/specifications/core-metadata/#version
__version__ = '3.1.6.2'
__author__ = 'Nicolas Hennion <nicolas@nicolargo.com>'
__license__ = 'LGPLv3'

# Import psutil
try:
    from psutil import __version__ as psutil_version

import missing from __future__ import absolute_import

except ImportError:
    print('psutil library not found. Glances cannot start.')

Unnecessary parens after u'print' keyword

print statement used

    sys.exit(1)

# Import Glances libs
# Note: others Glances libs will be imported optionally
from glances.logger import logger

import missing from __future__ import absolute_import

from glances.main import GlancesMain

import missing from __future__ import absolute_import

from glances.globals import WINDOWS

import missing from __future__ import absolute_import

from glances.timer import Counter

import missing from __future__ import absolute_import

# Check locale
try:
    locale.setlocale(locale.LC_ALL, '')
except locale.Error:
    print("Warning: Unable to set locale. Expect encoding problems.")

Unnecessary parens after u'print' keyword

print statement used

# Check Python version
if sys.version_info < (2, 7) or (3, 0) <= sys.version_info < (3, 4):
    print('Glances requires at least Python 2.7 or 3.4 to run.')

Unnecessary parens after u'print' keyword

print statement used

    sys.exit(1)

# Check psutil version
psutil_min_version = (5, 3, 0)

The name psutil_min_version does not conform to the constant naming conventions ((([A-Z_][A-Z0-9_]*)|(__.*__))$).

psutil_version_info = tuple([int(num) for num in psutil_version.split('.')])

The name psutil_version_info does not conform to the constant naming conventions ((([A-Z_][A-Z0-9_]*)|(__.*__))$).

if psutil_version_info < psutil_min_version:
    print('psutil 5.3.0 or higher is needed. Glances cannot start.')

Unnecessary parens after u'print' keyword

print statement used

    sys.exit(1)


def __signal_handler(signal, frame):

signal is re-defining a name which is already available in the outer-scope (previously defined on line 26).

The argument signal seems to be unused.

The argument frame seems to be unused.

    """Callback for CTRL-C."""
    end()


def end():
    """Stop Glances."""
    try:
        mode.end()

The variable mode does not seem to be defined.

    except NameError:
        # NameError: name 'mode' is not defined in case of interrupt shortly...
        # ...after starting the server mode (issue #1175)
        pass

    logger.info("Glances stopped (keypressed: CTRL-C)")

    # The end...
    sys.exit(0)


def start(config, args):
    """Start Glances."""

    # Load mode
    global mode

Global variable 'mode' undefined at the module level

The name mode does not conform to the constant naming conventions ((([A-Z_][A-Z0-9_]*)|(__.*__))$).

    start_duration = Counter()

    if core.is_standalone():

The variable core does not seem to be defined.

        from glances.standalone import GlancesStandalone as GlancesMode

import missing from __future__ import absolute_import

    elif core.is_client():
        if core.is_client_browser():
            from glances.client_browser import GlancesClientBrowser as GlancesMode

This line is too long as per the coding-style (82/80).

import missing from __future__ import absolute_import

        else:
            from glances.client import GlancesClient as GlancesMode

import missing from __future__ import absolute_import

    elif core.is_server():
        from glances.server import GlancesServer as GlancesMode

import missing from __future__ import absolute_import

    elif core.is_webserver():
        from glances.webserver import GlancesWebServer as GlancesMode

import missing from __future__ import absolute_import

    # Init the mode
    logger.info("Start {} mode".format(GlancesMode.__name__))

Use formatting in logging functions and pass the parameters as arguments

The variable GlancesMode does not seem to be defined for all execution paths.

    mode = GlancesMode(config=config, args=args)

    # Start the main loop
    logger.debug("Glances started in {} seconds".format(start_duration.get()))

Use formatting in logging functions and pass the parameters as arguments

    mode.serve_forever()

    # Shutdown
    mode.end()


def main():
    """Main entry point for Glances.

    Select the mode (standalone, client or server)
    Run it...
    """
    # Catch the CTRL-C signal
    signal.signal(signal.SIGINT, __signal_handler)

    # Log Glances and psutil version
    logger.info('Start Glances {}'.format(__version__))

Use formatting in logging functions and pass the parameters as arguments

    logger.info('{} {} and psutil {} detected'.format(

Use formatting in logging functions and pass the parameters as arguments

        platform.python_implementation(),
        platform.python_version(),
        psutil_version))

    # Share global var
    global core

Global variable 'core' undefined at the module level

The name core does not conform to the constant naming conventions ((([A-Z_][A-Z0-9_]*)|(__.*__))$).

    # Create the Glances main instance
    core = GlancesMain()
    config = core.get_config()
    args = core.get_args()

    # Glances can be ran in standalone, client or server mode
    start(config=config, args=args)