reports.meterrealtime.Reporting.on_options() - Code Metrics - Inspection of "Merge branch 'develop'" - myems/myems-api - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( dc4cf6...d9c3b0 )

by Guangyu

created 2021-01-06 13:56 UTC

reports.meterrealtime.Reporting.on_options() A

↳ Parent: reports.meterrealtime

Complexity

Conditions

Size

Total Lines	3
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nop	2
dl	0
loc	3
rs	10
c	0
b	0
f	0

import falcon
import simplejson as json
import mysql.connector
import config
from datetime import datetime, timedelta, timezone
import utilities
from decimal import *


class Reporting:
    @staticmethod
    def __init__():
        pass

    @staticmethod
    def on_options(req, resp):
        resp.status = falcon.HTTP_200

    ####################################################################################################################
    # PROCEDURES
    # Step 1: valid parameters
    # Step 2: query the meter and energy category
    # Step 3: query associated points
    # Step 4: query reporting period points trends
    # Step 5: query tariff data
    # Step 6: construct the report
    ####################################################################################################################
    @staticmethod
    def on_get(req, resp):
        print(req.params)
        meter_id = req.params.get('meterid')

        ################################################################################################################
        # Step 1: valid parameters
        ################################################################################################################
        if meter_id is None:
            raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_METER_ID')
        else:
            meter_id = str.strip(meter_id)
            if not meter_id.isdigit() or int(meter_id) <= 0:
                raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_METER_ID')

        timezone_offset = int(config.utc_offset[1:3]) * 60 + int(config.utc_offset[4:6])
        if config.utc_offset[0] == '-':
            timezone_offset = -timezone_offset

        reporting_end_datetime_utc = datetime.utcnow()
        reporting_start_datetime_utc = reporting_end_datetime_utc - timedelta(minutes=60)
        ################################################################################################################
        # Step 2: query the meter and energy category
        ################################################################################################################
        cnx_system = mysql.connector.connect(**config.myems_system_db)
        cursor_system = cnx_system.cursor()

        cnx_historical = mysql.connector.connect(**config.myems_historical_db)
        cursor_historical = cnx_historical.cursor()

        cursor_system.execute(" SELECT m.id, m.name, m.cost_center_id, m.energy_category_id, "
                              "        ec.name, ec.unit_of_measure "
                              " FROM tbl_meters m, tbl_energy_categories ec "
                              " WHERE m.id = %s AND m.energy_category_id = ec.id ", (meter_id,))
        row_meter = cursor_system.fetchone()
        if row_meter is None:
            if cursor_system:
                cursor_system.close()
            if cnx_system:
                cnx_system.disconnect()

            if cursor_historical:
                cursor_historical.close()
            if cnx_historical:
                cnx_historical.disconnect()
            raise falcon.HTTPError(falcon.HTTP_404, title='API.NOT_FOUND', description='API.METER_NOT_FOUND')

        meter = dict()
        meter['id'] = row_meter[0]
        meter['name'] = row_meter[1]
        meter['cost_center_id'] = row_meter[2]
        meter['energy_category_id'] = row_meter[3]
        meter['energy_category_name'] = row_meter[4]
        meter['unit_of_measure'] = row_meter[5]

        ################################################################################################################
        # Step 3: query associated points
        ################################################################################################################
        point_list = list()
        cursor_system.execute(" SELECT p.id, p.name, p.units, p.object_type  "
                              " FROM tbl_meters m, tbl_meters_points mp, tbl_points p "
                              " WHERE m.id = %s AND m.id = mp.meter_id AND mp.point_id = p.id "
                              " ORDER BY p.id ", (meter['id'],))
        rows_points = cursor_system.fetchall()
        if rows_points is not None and len(rows_points) > 0:
            for row in rows_points:
                point_list.append({"id": row[0], "name": row[1], "units": row[2], "object_type": row[3]})

        ################################################################################################################
        # Step 7: query associated points data
        ################################################################################################################
        energy_value_data = dict()
        energy_value_data['name'] = None
        energy_value_data['timestamps'] = list()
        energy_value_data['values'] = list()

        parameters_data = dict()
        parameters_data['names'] = list()
        parameters_data['timestamps'] = list()
        parameters_data['values'] = list()

        for point in point_list:
            point_values = []
            point_timestamps = []
            if point['object_type'] == 'ANALOG_VALUE':

                query = (" SELECT utc_date_time, actual_value "
                         " FROM tbl_analog_value "
                         " WHERE point_id = %s "
                         "       AND utc_date_time BETWEEN %s AND %s "
                         " ORDER BY utc_date_time ")
                cursor_historical.execute(query, (point['id'],
                                                  reporting_start_datetime_utc,
                                                  reporting_end_datetime_utc))
                rows = cursor_historical.fetchall()

                if rows is not None and len(rows) > 0:
                    for row in rows:
                        current_datetime_local = row[0].replace(tzinfo=timezone.utc) + \
                                                 timedelta(minutes=timezone_offset)
                        current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
                        point_timestamps.append(current_datetime)
                        point_values.append(row[1])

                parameters_data['names'].append(point['name'] + ' (' + point['units'] + ')')
                parameters_data['timestamps'].append(point_timestamps)
                parameters_data['values'].append(point_values)
            elif point['object_type'] == 'ENERGY_VALUE':
                energy_value_data['name'] = point['name']
                query = (" SELECT utc_date_time, actual_value "
                         " FROM tbl_energy_value "
                         " WHERE point_id = %s "
                         "       AND utc_date_time BETWEEN %s AND %s "
                         " ORDER BY utc_date_time ")
                cursor_historical.execute(query, (point['id'],
                                                  reporting_start_datetime_utc,
                                                  reporting_end_datetime_utc))
                rows = cursor_historical.fetchall()

                if rows is not None and len(rows) > 0:

                    for row in rows:
                        current_datetime_local = row[0].replace(tzinfo=timezone.utc) + \
                                                 timedelta(minutes=timezone_offset)
                        current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
                        energy_value_data['timestamps'].append(current_datetime)
                        energy_value_data['values'].append(row[1])

            elif point['object_type'] == 'DIGITAL_VALUE':
                query = (" SELECT utc_date_time, actual_value "
                         " FROM tbl_digital_value "
                         " WHERE point_id = %s "
                         "       AND utc_date_time BETWEEN %s AND %s ")
                cursor_historical.execute(query, (point['id'],
                                                  reporting_start_datetime_utc,
                                                  reporting_end_datetime_utc))
                rows = cursor_historical.fetchall()

                if rows is not None and len(rows) > 0:
                    for row in rows:
                        current_datetime_local = row[0].replace(tzinfo=timezone.utc) + \
                                                 timedelta(minutes=timezone_offset)
                        current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
                        point_timestamps.append(current_datetime)
                        point_values.append(row[1])

                parameters_data['names'].append(point['name'] + ' (' + point['units'] + ')')
                parameters_data['timestamps'].append(point_timestamps)
                parameters_data['values'].append(point_values)

        ################################################################################################################
        # Step 6: construct the report
        ################################################################################################################
        if cursor_system:
            cursor_system.close()
        if cnx_system:
            cnx_system.disconnect()

        if cursor_historical:
            cursor_historical.close()
        if cnx_historical:
            cnx_historical.disconnect()

        result = {
            "meter": {
                "cost_center_id": meter['cost_center_id'],
                "energy_category_id": meter['energy_category_id'],
                "energy_category_name": meter['energy_category_name'],
                "unit_of_measure": meter['unit_of_measure'],
            },
            "energy_value": energy_value_data,
            "parameters": {
                "names": parameters_data['names'],
                "timestamps": parameters_data['timestamps'],
                "values": parameters_data['values']
            },

        }

        resp.body = json.dumps(result)


1			import falcon
2			import simplejson as json
3			import mysql.connector
4			import config
5			from datetime import datetime, timedelta, timezone
6			import utilities
7			from decimal import *
8
9
10			class Reporting:
11			@staticmethod
12			def __init__():
13			pass
14
15			@staticmethod
16			def on_options(req, resp):
17			resp.status = falcon.HTTP_200
18
19			####################################################################################################################
20			# PROCEDURES
21			# Step 1: valid parameters
22			# Step 2: query the meter and energy category
23			# Step 3: query associated points
24			# Step 4: query reporting period points trends
25			# Step 5: query tariff data
26			# Step 6: construct the report
27			####################################################################################################################
28			@staticmethod
29			def on_get(req, resp):
30			print(req.params)
31			meter_id = req.params.get('meterid')
32
33			################################################################################################################
34			# Step 1: valid parameters
35			################################################################################################################
36			if meter_id is None:
37			raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_METER_ID')
38			else:
39			meter_id = str.strip(meter_id)
40			if not meter_id.isdigit() or int(meter_id) <= 0:
41			raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_METER_ID')
42
43			timezone_offset = int(config.utc_offset[1:3]) * 60 + int(config.utc_offset[4:6])
44			if config.utc_offset[0] == '-':
45			timezone_offset = -timezone_offset
46
47			reporting_end_datetime_utc = datetime.utcnow()
48			reporting_start_datetime_utc = reporting_end_datetime_utc - timedelta(minutes=60)
49			################################################################################################################
50			# Step 2: query the meter and energy category
51			################################################################################################################
52			cnx_system = mysql.connector.connect(**config.myems_system_db)
53			cursor_system = cnx_system.cursor()
54
55			cnx_historical = mysql.connector.connect(**config.myems_historical_db)
56			cursor_historical = cnx_historical.cursor()
57
58			cursor_system.execute(" SELECT m.id, m.name, m.cost_center_id, m.energy_category_id, "
59			" ec.name, ec.unit_of_measure "
60			" FROM tbl_meters m, tbl_energy_categories ec "
61			" WHERE m.id = %s AND m.energy_category_id = ec.id ", (meter_id,))
62			row_meter = cursor_system.fetchone()
63			if row_meter is None:
64			if cursor_system:
65			cursor_system.close()
66			if cnx_system:
67			cnx_system.disconnect()
68
69			if cursor_historical:
70			cursor_historical.close()
71			if cnx_historical:
72			cnx_historical.disconnect()
73			raise falcon.HTTPError(falcon.HTTP_404, title='API.NOT_FOUND', description='API.METER_NOT_FOUND')
74
75			meter = dict()
76			meter['id'] = row_meter[0]
77			meter['name'] = row_meter[1]
78			meter['cost_center_id'] = row_meter[2]
79			meter['energy_category_id'] = row_meter[3]
80			meter['energy_category_name'] = row_meter[4]
81			meter['unit_of_measure'] = row_meter[5]
82
83			################################################################################################################
84			# Step 3: query associated points
85			################################################################################################################
86			point_list = list()
87			cursor_system.execute(" SELECT p.id, p.name, p.units, p.object_type "
88			" FROM tbl_meters m, tbl_meters_points mp, tbl_points p "
89			" WHERE m.id = %s AND m.id = mp.meter_id AND mp.point_id = p.id "
90			" ORDER BY p.id ", (meter['id'],))
91			rows_points = cursor_system.fetchall()
92			if rows_points is not None and len(rows_points) > 0:
93			for row in rows_points:
94			point_list.append({"id": row[0], "name": row[1], "units": row[2], "object_type": row[3]})
95
96			################################################################################################################
97			# Step 7: query associated points data
98			################################################################################################################
99			energy_value_data = dict()
100			energy_value_data['name'] = None
101			energy_value_data['timestamps'] = list()
102			energy_value_data['values'] = list()
103
104			parameters_data = dict()
105			parameters_data['names'] = list()
106			parameters_data['timestamps'] = list()
107			parameters_data['values'] = list()
108
109			for point in point_list:
110			point_values = []
111			point_timestamps = []
112			if point['object_type'] == 'ANALOG_VALUE':
113
114			query = (" SELECT utc_date_time, actual_value "
115			" FROM tbl_analog_value "
116			" WHERE point_id = %s "
117			" AND utc_date_time BETWEEN %s AND %s "
118			" ORDER BY utc_date_time ")
119			cursor_historical.execute(query, (point['id'],
120			reporting_start_datetime_utc,
121			reporting_end_datetime_utc))
122			rows = cursor_historical.fetchall()
123
124			if rows is not None and len(rows) > 0:
125			for row in rows:
126			current_datetime_local = row[0].replace(tzinfo=timezone.utc) + \
127			timedelta(minutes=timezone_offset)
128			current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
129			point_timestamps.append(current_datetime)
130			point_values.append(row[1])
131
132			parameters_data['names'].append(point['name'] + ' (' + point['units'] + ')')
133			parameters_data['timestamps'].append(point_timestamps)
134			parameters_data['values'].append(point_values)
135			elif point['object_type'] == 'ENERGY_VALUE':
136			energy_value_data['name'] = point['name']
137			query = (" SELECT utc_date_time, actual_value "
138			" FROM tbl_energy_value "
139			" WHERE point_id = %s "
140			" AND utc_date_time BETWEEN %s AND %s "
141			" ORDER BY utc_date_time ")
142			cursor_historical.execute(query, (point['id'],
143			reporting_start_datetime_utc,
144			reporting_end_datetime_utc))
145			rows = cursor_historical.fetchall()
146
147			if rows is not None and len(rows) > 0:
148
149			for row in rows:
150			current_datetime_local = row[0].replace(tzinfo=timezone.utc) + \
151			timedelta(minutes=timezone_offset)
152			current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
153			energy_value_data['timestamps'].append(current_datetime)
154			energy_value_data['values'].append(row[1])
155
156			elif point['object_type'] == 'DIGITAL_VALUE':
157			query = (" SELECT utc_date_time, actual_value "
158			" FROM tbl_digital_value "
159			" WHERE point_id = %s "
160			" AND utc_date_time BETWEEN %s AND %s ")
161			cursor_historical.execute(query, (point['id'],
162			reporting_start_datetime_utc,
163			reporting_end_datetime_utc))
164			rows = cursor_historical.fetchall()
165
166			if rows is not None and len(rows) > 0:
167			for row in rows:
168			current_datetime_local = row[0].replace(tzinfo=timezone.utc) + \
169			timedelta(minutes=timezone_offset)
170			current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
171			point_timestamps.append(current_datetime)
172			point_values.append(row[1])
173
174			parameters_data['names'].append(point['name'] + ' (' + point['units'] + ')')
175			parameters_data['timestamps'].append(point_timestamps)
176			parameters_data['values'].append(point_values)
177
178			################################################################################################################
179			# Step 6: construct the report
180			################################################################################################################
181			if cursor_system:
182			cursor_system.close()
183			if cnx_system:
184			cnx_system.disconnect()
185
186			if cursor_historical:
187			cursor_historical.close()
188			if cnx_historical:
189			cnx_historical.disconnect()
190
191			result = {
192			"meter": {
193			"cost_center_id": meter['cost_center_id'],
194			"energy_category_id": meter['energy_category_id'],
195			"energy_category_name": meter['energy_category_name'],
196			"unit_of_measure": meter['unit_of_measure'],
197			},
198			"energy_value": energy_value_data,
199			"parameters": {
200			"names": parameters_data['names'],
201			"timestamps": parameters_data['timestamps'],
202			"values": parameters_data['values']
203			},
204
205			}
206
207			resp.body = json.dumps(result)
208

myems / myems-api

Push — master ( dc4cf6...d9c3b0 )

reports.meterrealtime.Reporting.on_options() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like