Host.__init__() - Code Metrics - Inspection of "Used new features of PyStratum." - SetBased/py-enarksh - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 3b532d...9b942b )

by P.R.

created 2016-11-21 09:45 UTC

Host.init() B

↳ Parent: Host

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	1
dl	0
loc	24
ccs	0
cts	5
cp	0
crap	2
rs	8.9713
c	3
b	0
f	0

"""
Enarksh

Copyright 2013-2016 Set Based IT Consultancy

Licence MIT
"""
from enarksh.DataLayer import DataLayer
from enarksh.xml_reader.resource import create_resource, ReadWriteLockResource, CountingResource


class Host:
    """
    Program for loading a host definition into the database.
    """

    # ------------------------------------------------------------------------------------------------------------------
    def __init__(self):
        """
        Object constructor.
        """
        self._hostname = ''
        """
        The name of this host.

        :type: str
        """

        self._hst_id = 0
        """
        The ID of this host when it is stored in the databases.

        :type: int
        """

        self._resources = {}
        """
        The resources of this host.

        :type: dict
        """

    # ------------------------------------------------------------------------------------------------------------------
    def load_db(self, hostname):
        """
        Loads the definition of this host from the database.

        :param str hostname: The name of the host that must be loaded.
        """
        self._hostname = hostname

        host = DataLayer.enk_reader_host_load_host(hostname)
        self._hst_id = host['hst_id']

        resources_data = DataLayer.enk_back_get_host_resources()
        for resource_data in resources_data:
            resource = create_resource(resource_data['rtp_id'], resource_data['rsc_id'], None)
            self._resources[resource.name] = resource

    # ------------------------------------------------------------------------------------------------------------------
    def get_resource_by_name(self, resource_name):
        """
        :param str resource_name:

        :rtype: Resource|None
        """
        if resource_name in self._resources:
            return self._resources[resource_name]

        return None

    # ------------------------------------------------------------------------------------------------------------------
    def read_xml(self, xml):
        """
        :param xml.etree.ElementTree.Element xml:
        """
        for element in list(xml):
            tag = element.tag
            if tag == 'Hostname':
                self._hostname = element.text

            elif tag == 'Resources':
                self._read_xml_resources(element)

            else:
                raise Exception("Unexpected tag '{0!s}'.".format(tag))

    # ------------------------------------------------------------------------------------------------------------------
    def validate(self):
        """
        Validates this node against rules which are not imposed by XSD.
        """
        errors = []
        self._validate_helper(errors)

    # ------------------------------------------------------------------------------------------------------------------
    def _validate_helper(self, errors):
        """
        Helper function for validation this node.

        :param list errors: A list of error messages.
        """
        if self._hostname != 'localhost':
            err = {'uri':   self.get_uri(),
                   'rule':  'Currently, only localhost is supported.',
                   'error': "Hostname must be 'localhost', found: '{0!s}'.".format(self._hostname)}
            errors.append(err)

    # ------------------------------------------------------------------------------------------------------------------
    def get_uri(self, obj_type='host'):
        """
        Returns the URI of this host.

        :param str obj_type: The entity type.

        :rtype: str
        """
        return '//' + obj_type + '/' + self._hostname

    # ------------------------------------------------------------------------------------------------------------------
    def store(self):
        """
        Stores the definition of this host into the database.
        """
        # Get uri_id for this host.
        uri_id = DataLayer.enk_misc_insert_uri(self.get_uri())

        # Store the definition of the host self.
        self._store_self(uri_id)

        # Store the resources of this host.
        for resource in self._resources.values():
            resource.store(self._hst_id, None)

    # ------------------------------------------------------------------------------------------------------------------
    def _store_self(self, uri_id):

        """
        Stores the definition of this host into the database.

        :param int uri_id: The ID of the URI of this node.
        """
        details = DataLayer.enk_reader_host_load_host(self._hostname)
        self._hst_id = details['hst_id']

    # ------------------------------------------------------------------------------------------------------------------
    def _read_xml_resources(self, xml):
        """
        :param xml.etree.ElementTree.Element xml:
        """
        for element in list(xml):
            tag = element.tag
            if tag == 'CountingResource':
                resource = CountingResource(self)

            elif tag == 'ReadWriteLockResource':
                resource = ReadWriteLockResource(self)

            else:
                raise Exception("Unexpected tag '{0!s}'.".format(tag))

            resource.read_xml(element)
            name = resource.name
            # Check for resources with duplicate names.
            if name in self._resources:
                raise Exception("Duplicate resource '{0!s}'.".format(name))

            self._resources[name] = resource

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


1			"""
2			Enarksh
3
4			Copyright 2013-2016 Set Based IT Consultancy
5
6			Licence MIT
7			"""
8			from enarksh.DataLayer import DataLayer
9			from enarksh.xml_reader.resource import create_resource, ReadWriteLockResource, CountingResource
10
11
12			class Host:
13			"""
14			Program for loading a host definition into the database.
15			"""
16
17			# ------------------------------------------------------------------------------------------------------------------
18			def __init__(self):
19			"""
20			Object constructor.
21			"""
22			self._hostname = ''
23			"""
24			The name of this host.
25
26			:type: str
27			"""
28
29			self._hst_id = 0
30			"""
31			The ID of this host when it is stored in the databases.
32
33			:type: int
34			"""
35
36			self._resources = {}
37			"""
38			The resources of this host.
39
40			:type: dict
41			"""
42
43			# ------------------------------------------------------------------------------------------------------------------
44			def load_db(self, hostname):
45			"""
46			Loads the definition of this host from the database.
47
48			:param str hostname: The name of the host that must be loaded.
49			"""
50			self._hostname = hostname
51
52			host = DataLayer.enk_reader_host_load_host(hostname)
53			self._hst_id = host['hst_id']
54
55			resources_data = DataLayer.enk_back_get_host_resources()
56			for resource_data in resources_data:
57			resource = create_resource(resource_data['rtp_id'], resource_data['rsc_id'], None)
58			self._resources[resource.name] = resource
59
60			# ------------------------------------------------------------------------------------------------------------------
61			def get_resource_by_name(self, resource_name):
62			"""
63			:param str resource_name:
64
65			:rtype: Resource\|None
66			"""
67			if resource_name in self._resources:
68			return self._resources[resource_name]
69
70			return None
71
72			# ------------------------------------------------------------------------------------------------------------------
73			def read_xml(self, xml):
74			"""
75			:param xml.etree.ElementTree.Element xml:
76			"""
77			for element in list(xml):
78			tag = element.tag
79			if tag == 'Hostname':
80			self._hostname = element.text
81
82			elif tag == 'Resources':
83			self._read_xml_resources(element)
84
85			else:
86			raise Exception("Unexpected tag '{0!s}'.".format(tag))
87
88			# ------------------------------------------------------------------------------------------------------------------
89			def validate(self):
90			"""
91			Validates this node against rules which are not imposed by XSD.
92			"""
93			errors = []
94			self._validate_helper(errors)
95
96			# ------------------------------------------------------------------------------------------------------------------
97			def _validate_helper(self, errors):
98			"""
99			Helper function for validation this node.
100
101			:param list errors: A list of error messages.
102			"""
103			if self._hostname != 'localhost':
104			err = {'uri': self.get_uri(),
105			'rule': 'Currently, only localhost is supported.',
106			'error': "Hostname must be 'localhost', found: '{0!s}'.".format(self._hostname)}
107			errors.append(err)
108
109			# ------------------------------------------------------------------------------------------------------------------
110			def get_uri(self, obj_type='host'):
111			"""
112			Returns the URI of this host.
113
114			:param str obj_type: The entity type.
115
116			:rtype: str
117			"""
118			return '//' + obj_type + '/' + self._hostname
119
120			# ------------------------------------------------------------------------------------------------------------------
121			def store(self):
122			"""
123			Stores the definition of this host into the database.
124			"""
125			# Get uri_id for this host.
126			uri_id = DataLayer.enk_misc_insert_uri(self.get_uri())
127
128			# Store the definition of the host self.
129			self._store_self(uri_id)
130
131			# Store the resources of this host.
132			for resource in self._resources.values():
133			resource.store(self._hst_id, None)
134
135			# ------------------------------------------------------------------------------------------------------------------
136			def _store_self(self, uri_id):
			0 ignored issues – show Unused Code introduced 2016-07-29 16:28 UTC by Report Bug Copy Issue Report The argument `uri_id` seems to be unused. Loading history...
137			"""
138			Stores the definition of this host into the database.
139
140			:param int uri_id: The ID of the URI of this node.
141			"""
142			details = DataLayer.enk_reader_host_load_host(self._hostname)
143			self._hst_id = details['hst_id']
144
145			# ------------------------------------------------------------------------------------------------------------------
146			def _read_xml_resources(self, xml):
147			"""
148			:param xml.etree.ElementTree.Element xml:
149			"""
150			for element in list(xml):
151			tag = element.tag
152			if tag == 'CountingResource':
153			resource = CountingResource(self)
154
155			elif tag == 'ReadWriteLockResource':
156			resource = ReadWriteLockResource(self)
157
158			else:
159			raise Exception("Unexpected tag '{0!s}'.".format(tag))
160
161			resource.read_xml(element)
162			name = resource.name
163			# Check for resources with duplicate names.
164			if name in self._resources:
165			raise Exception("Duplicate resource '{0!s}'.".format(name))
166
167			self._resources[name] = resource
168
169			# ----------------------------------------------------------------------------------------------------------------------
170

SetBased / py-enarksh

GitHub Access Token became invalid

Push — master ( 3b532d...9b942b )

Host.__init__() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Host.init() B