LoadScheduleClient._zmq_init() - Code Metrics - Inspection of "Implemented command node_action." - SetBased/py-enarksh - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( fac2c4...4a4d5a )

by P.R.

created 2016-10-19 17:56 UTC

LoadScheduleClient._zmq_init() A

↳ Parent: LoadScheduleClient

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
c	1
b	0
f	0
dl	0
loc	6
ccs	0
cts	4
cp	0
crap	2
rs	9.4285

"""
Enarksh

Copyright 2013-2016 Set Based IT Consultancy

Licence MIT
"""
import os
import sys
import traceback

import zmq

import enarksh
from enarksh.controller.message.ScheduleDefinitionMessage import ScheduleDefinitionMessage


class LoadScheduleClient:
    """
    A client for requesting the controller to load new schedules.
    """

    # ------------------------------------------------------------------------------------------------------------------
    def __init__(self):
        self._zmq_context = None
        """
        The ZMQ context.

        :type: Context
        """

        self._zmq_controller = None
        """
        The socket for communicating with the controller.

        :type: zmq.sugar.socket.Socket
        """

    # ------------------------------------------------------------------------------------------------------------------
    def main(self, filenames):
        """
        The main function of load_schedule.

        :param list[str] filenames: The filenames of the schedules to be loaded.
        """
        # Initialize ZMQ.
        self._zmq_init()

        # Send XML files to the controller.
        status = 0
        for filename in filenames:
            try:
                err = self._load_schedule(filename)
                if err:
                    status = -1
            except Exception as exception:
                print(exception, file=sys.stderr)
                traceback.print_exc(file=sys.stderr)
                status = -1

        return status

    # ------------------------------------------------------------------------------------------------------------------
    def _zmq_init(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self._zmq_context = zmq.Context()

        # Create socket for communicating with the controller.
        self._zmq_controller = self._zmq_context.socket(zmq.REQ)
        self._zmq_controller.connect(enarksh.CONTROLLER_LOCKSTEP_END_POINT)

    # ------------------------------------------------------------------------------------------------------------------
    def _load_schedule(self, filename):
        """
        Sends a message to the controller to load a new schedule definition.

        :param str filename: The name of XML file with the schedule definition.

        :rtype bool: True on success. Otherwise False.
        """
        with open(filename, 'rt', encoding='utf-8') as f:

            xml = f.read()

        # Compose the message for the controller.
        message = ScheduleDefinitionMessage(xml, os.path.realpath(filename))

        # Send the message to the controller.
        self._zmq_controller.send_pyobj(message)

        # Await the response from the controller.
        response = self._zmq_controller.recv_json()

        print(response['message'], end='')
        if response['message'][-1:] != '\n':
            print()

        return response['ret'] == 0

# ----------------------------------------------------------------------------------------------------------------------


1			"""
2			Enarksh
3
4			Copyright 2013-2016 Set Based IT Consultancy
5
6			Licence MIT
7			"""
8			import os
9			import sys
10			import traceback
11
12			import zmq
13
14			import enarksh
15			from enarksh.controller.message.ScheduleDefinitionMessage import ScheduleDefinitionMessage
16
17
18			class LoadScheduleClient:
19			"""
20			A client for requesting the controller to load new schedules.
21			"""
22
23			# ------------------------------------------------------------------------------------------------------------------
24			def __init__(self):
25			self._zmq_context = None
26			"""
27			The ZMQ context.
28
29			:type: Context
30			"""
31
32			self._zmq_controller = None
33			"""
34			The socket for communicating with the controller.
35
36			:type: zmq.sugar.socket.Socket
37			"""
38
39			# ------------------------------------------------------------------------------------------------------------------
40			def main(self, filenames):
41			"""
42			The main function of load_schedule.
43
44			:param list[str] filenames: The filenames of the schedules to be loaded.
45			"""
46			# Initialize ZMQ.
47			self._zmq_init()
48
49			# Send XML files to the controller.
50			status = 0
51			for filename in filenames:
52			try:
53			err = self._load_schedule(filename)
54			if err:
55			status = -1
56			except Exception as exception:
57			print(exception, file=sys.stderr)
58			traceback.print_exc(file=sys.stderr)
59			status = -1
60
61			return status
62
63			# ------------------------------------------------------------------------------------------------------------------
64			def _zmq_init(self):
			0 ignored issues – show Coding Style introduced 2016-07-27 12:34 UTC by Report Bug Copy Issue Report This method should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
65			self._zmq_context = zmq.Context()
66
67			# Create socket for communicating with the controller.
68			self._zmq_controller = self._zmq_context.socket(zmq.REQ)
69			self._zmq_controller.connect(enarksh.CONTROLLER_LOCKSTEP_END_POINT)
70
71			# ------------------------------------------------------------------------------------------------------------------
72			def _load_schedule(self, filename):
73			"""
74			Sends a message to the controller to load a new schedule definition.
75
76			:param str filename: The name of XML file with the schedule definition.
77
78			:rtype bool: True on success. Otherwise False.
79			"""
80			with open(filename, 'rt', encoding='utf-8') as f:
			0 ignored issues – show Coding Style Naming introduced 2016-07-27 12:34 UTC by Report Bug Copy Issue Report The name `f` does not conform to the variable naming conventions (`[a-z_][a-z0-9_]{1,60}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
81			xml = f.read()
82
83			# Compose the message for the controller.
84			message = ScheduleDefinitionMessage(xml, os.path.realpath(filename))
85
86			# Send the message to the controller.
87			self._zmq_controller.send_pyobj(message)
88
89			# Await the response from the controller.
90			response = self._zmq_controller.recv_json()
91
92			print(response['message'], end='')
93			if response['message'][-1:] != '\n':
94			print()
95
96			return response['ret'] == 0
97
98			# ----------------------------------------------------------------------------------------------------------------------
99

SetBased / py-enarksh

GitHub Access Token became invalid

Push — master ( fac2c4...4a4d5a )

LoadScheduleClient._zmq_init() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like