Passed
Push — master ( e0aaf2...91c0a5 )
by Guangyu
01:57 queued 10s
created

reports/offlinemeterenergy.py (1 issue)

Severity
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 View Code Duplication
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 offline meter and energy category
23
    # Step 3: query base period energy consumption
24
    # Step 4: query reporting period energy consumption
25
    # Step 5: query parameters data
26
    # Step 6: construct the report
27
    ####################################################################################################################
28
    @staticmethod
29
    def on_get(req, resp):
30
        print(req.params)
31
        offline_meter_id = req.params.get('offlinemeterid')
32
        period_type = req.params.get('periodtype')
33
        base_period_start_datetime = req.params.get('baseperiodstartdatetime')
34
        base_period_end_datetime = req.params.get('baseperiodenddatetime')
35
        reporting_period_start_datetime = req.params.get('reportingperiodstartdatetime')
36
        reporting_period_end_datetime = req.params.get('reportingperiodenddatetime')
37
38
        ################################################################################################################
39
        # Step 1: valid parameters
40
        ################################################################################################################
41
        if offline_meter_id is None:
42
            raise falcon.HTTPError(falcon.HTTP_400,
43
                                   title='API.BAD_REQUEST',
44
                                   description='API.INVALID_OFFLINE_METER_ID')
45
        else:
46
            offline_meter_id = str.strip(offline_meter_id)
47
            if not offline_meter_id.isdigit() or int(offline_meter_id) <= 0:
48
                raise falcon.HTTPError(falcon.HTTP_400,
49
                                       title='API.BAD_REQUEST',
50
                                       description='API.INVALID_OFFLINE_METER_ID')
51
52
        if period_type is None:
53
            raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_PERIOD_TYPE')
54
        else:
55
            period_type = str.strip(period_type)
56
            if period_type not in ['hourly', 'daily', 'monthly', 'yearly']:
57
                raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_PERIOD_TYPE')
58
59
        timezone_offset = int(config.utc_offset[1:3]) * 60 + int(config.utc_offset[4:6])
60
        if config.utc_offset[0] == '-':
61
            timezone_offset = -timezone_offset
62
63
        base_start_datetime_utc = None
64
        if base_period_start_datetime is not None and len(str.strip(base_period_start_datetime)) > 0:
65
            base_period_start_datetime = str.strip(base_period_start_datetime)
66
            try:
67
                base_start_datetime_utc = datetime.strptime(base_period_start_datetime, '%Y-%m-%dT%H:%M:%S')
68
            except ValueError:
69
                raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
70
                                       description="API.INVALID_BASE_PERIOD_BEGINS_DATETIME")
71
            base_start_datetime_utc = base_start_datetime_utc.replace(tzinfo=timezone.utc) - \
72
                timedelta(minutes=timezone_offset)
73
74
        base_end_datetime_utc = None
75
        if base_period_end_datetime is not None and len(str.strip(base_period_end_datetime)) > 0:
76
            base_period_end_datetime = str.strip(base_period_end_datetime)
77
            try:
78
                base_end_datetime_utc = datetime.strptime(base_period_end_datetime, '%Y-%m-%dT%H:%M:%S')
79
            except ValueError:
80
                raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
81
                                       description="API.INVALID_BASE_PERIOD_ENDS_DATETIME")
82
            base_end_datetime_utc = base_end_datetime_utc.replace(tzinfo=timezone.utc) - \
83
                timedelta(minutes=timezone_offset)
84
85
        if base_start_datetime_utc is not None and base_end_datetime_utc is not None and \
86
                base_start_datetime_utc >= base_end_datetime_utc:
87
            raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
88
                                   description='API.INVALID_BASE_PERIOD_ENDS_DATETIME')
89
90
        if reporting_period_start_datetime is None:
91
            raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
92
                                   description="API.INVALID_REPORTING_PERIOD_BEGINS_DATETIME")
93
        else:
94
            reporting_period_start_datetime = str.strip(reporting_period_start_datetime)
95
            try:
96
                reporting_start_datetime_utc = datetime.strptime(reporting_period_start_datetime, '%Y-%m-%dT%H:%M:%S')
97
            except ValueError:
98
                raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
99
                                       description="API.INVALID_REPORTING_PERIOD_BEGINS_DATETIME")
100
            reporting_start_datetime_utc = reporting_start_datetime_utc.replace(tzinfo=timezone.utc) - \
101
                timedelta(minutes=timezone_offset)
102
103
        if reporting_period_end_datetime is None:
104
            raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
105
                                   description="API.INVALID_REPORTING_PERIOD_ENDS_DATETIME")
106
        else:
107
            reporting_period_end_datetime = str.strip(reporting_period_end_datetime)
108
            try:
109
                reporting_end_datetime_utc = datetime.strptime(reporting_period_end_datetime, '%Y-%m-%dT%H:%M:%S')
110
            except ValueError:
111
                raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
112
                                       description="API.INVALID_REPORTING_PERIOD_ENDS_DATETIME")
113
            reporting_end_datetime_utc = reporting_end_datetime_utc.replace(tzinfo=timezone.utc) - \
114
                timedelta(minutes=timezone_offset)
115
116
        if reporting_start_datetime_utc >= reporting_end_datetime_utc:
117
            raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
118
                                   description='API.INVALID_REPORTING_PERIOD_ENDS_DATETIME')
119
120
        ################################################################################################################
121
        # Step 2: query the offline meter and energy category
122
        ################################################################################################################
123
        cnx = mysql.connector.connect(**config.myems_system_db)
124
        cursor = cnx.cursor()
125
126
        cursor.execute(" SELECT m.id, m.name, m.cost_center_id, m.energy_category_id, "
127
                       "        ec.name, ec.unit_of_measure, ec.kgce, ec.kgco2e "
128
                       " FROM tbl_offline_meters m, tbl_energy_categories ec "
129
                       " WHERE m.id = %s AND m.energy_category_id = ec.id ", (offline_meter_id,))
130
        row_offline_meter = cursor.fetchone()
131
        if row_offline_meter is None:
132
            cursor.close()
133
            cnx.disconnect()
134
            raise falcon.HTTPError(falcon.HTTP_404, title='API.NOT_FOUND', description='API.OFFLINE_METER_NOT_FOUND')
135
136
        offline_meter = dict()
137
        offline_meter['id'] = row_offline_meter[0]
138
        offline_meter['name'] = row_offline_meter[1]
139
        offline_meter['cost_center_id'] = row_offline_meter[2]
140
        offline_meter['energy_category_id'] = row_offline_meter[3]
141
        offline_meter['energy_category_name'] = row_offline_meter[4]
142
        offline_meter['unit_of_measure'] = row_offline_meter[5]
143
        offline_meter['kgce'] = row_offline_meter[6]
144
        offline_meter['kgco2e'] = row_offline_meter[7]
145
146
        if cursor:
147
            cursor.close()
148
        if cnx:
149
            cnx.disconnect()
150
151
        ################################################################################################################
152
        # Step 3: query base period energy consumption
153
        ################################################################################################################
154
        cnx = mysql.connector.connect(**config.myems_energy_db)
155
        cursor = cnx.cursor()
156
        query = (" SELECT start_datetime_utc, actual_value "
157
                 " FROM tbl_offline_meter_hourly "
158
                 " WHERE offline_meter_id = %s "
159
                 " AND start_datetime_utc >= %s "
160
                 " AND start_datetime_utc < %s "
161
                 " ORDER BY start_datetime_utc ")
162
        cursor.execute(query, (offline_meter['id'], base_start_datetime_utc, base_end_datetime_utc))
163
        rows_offline_meter_hourly = cursor.fetchall()
164
165
        rows_offline_meter_periodically = utilities.aggregate_hourly_data_by_period(rows_offline_meter_hourly,
166
                                                                                    base_start_datetime_utc,
167
                                                                                    base_end_datetime_utc,
168
                                                                                    period_type)
169
        base = dict()
170
        base['timestamps'] = list()
171
        base['values_in_category'] = list()
172
        base['total_in_category'] = Decimal(0.0)
173
        base['values_in_kgce'] = list()
174
        base['total_in_kgce'] = Decimal(0.0)
175
        base['values_in_kgco2e'] = list()
176
        base['total_in_kgco2e'] = Decimal(0.0)
177
178
        for row_offline_meter_periodically in rows_offline_meter_periodically:
179
            current_datetime_local = row_offline_meter_periodically[0].replace(tzinfo=timezone.utc) + \
180
                                     timedelta(minutes=timezone_offset)
181
            if period_type == 'hourly':
182
                current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
183
            elif period_type == 'daily':
184
                current_datetime = current_datetime_local.strftime('%Y-%m-%d')
185
            elif period_type == 'monthly':
186
                current_datetime = current_datetime_local.strftime('%Y-%m')
187
            elif period_type == 'yearly':
188
                current_datetime = current_datetime_local.strftime('%Y')
189
190
            actual_value = Decimal(0.0) if row_offline_meter_periodically[1] is None \
191
                else row_offline_meter_periodically[1]
192
            base['timestamps'].append(current_datetime)
0 ignored issues
show
The variable current_datetime does not seem to be defined for all execution paths.
Loading history...
193
            base['values_in_category'].append(actual_value)
194
            base['total_in_category'] += actual_value
195
            base['values_in_kgce'].append(actual_value * offline_meter['kgce'])
196
            base['total_in_kgce'] += actual_value * offline_meter['kgce']
197
            base['values_in_kgco2e'].append(actual_value * offline_meter['kgco2e'])
198
            base['total_in_kgco2e'] += actual_value * offline_meter['kgco2e']
199
        ################################################################################################################
200
        # Step 3: query reporting period energy consumption
201
        ################################################################################################################
202
203
        query = (" SELECT start_datetime_utc, actual_value "
204
                 " FROM tbl_offline_meter_hourly "
205
                 " WHERE offline_meter_id = %s "
206
                 " AND start_datetime_utc >= %s "
207
                 " AND start_datetime_utc < %s "
208
                 " ORDER BY start_datetime_utc ")
209
        cursor.execute(query, (offline_meter['id'], reporting_start_datetime_utc, reporting_end_datetime_utc))
210
        rows_offline_meter_hourly = cursor.fetchall()
211
212
        rows_offline_meter_periodically = utilities.aggregate_hourly_data_by_period(rows_offline_meter_hourly,
213
                                                                                    reporting_start_datetime_utc,
214
                                                                                    reporting_end_datetime_utc,
215
                                                                                    period_type)
216
        reporting = dict()
217
        reporting['timestamps'] = list()
218
        reporting['values_in_category'] = list()
219
        reporting['total_in_category'] = Decimal(0.0)
220
        reporting['values_in_kgce'] = list()
221
        reporting['total_in_kgce'] = Decimal(0.0)
222
        reporting['values_in_kgco2e'] = list()
223
        reporting['total_in_kgco2e'] = Decimal(0.0)
224
225
        for row_offline_meter_periodically in rows_offline_meter_periodically:
226
            current_datetime_local = row_offline_meter_periodically[0].replace(tzinfo=timezone.utc) + \
227
                timedelta(minutes=timezone_offset)
228
            if period_type == 'hourly':
229
                current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
230
            elif period_type == 'daily':
231
                current_datetime = current_datetime_local.strftime('%Y-%m-%d')
232
            elif period_type == 'monthly':
233
                current_datetime = current_datetime_local.strftime('%Y-%m')
234
            elif period_type == 'yearly':
235
                current_datetime = current_datetime_local.strftime('%Y')
236
237
            actual_value = Decimal(0.0) if row_offline_meter_periodically[1] is None \
238
                else row_offline_meter_periodically[1]
239
240
            reporting['timestamps'].append(current_datetime)
241
            reporting['values_in_category'].append(actual_value)
242
            reporting['total_in_category'] += actual_value
243
            reporting['values_in_kgce'].append(actual_value * offline_meter['kgce'])
244
            reporting['total_in_kgce'] += actual_value * offline_meter['kgce']
245
            reporting['values_in_kgco2e'].append(actual_value * offline_meter['kgco2e'])
246
            reporting['total_in_kgco2e'] += actual_value * offline_meter['kgco2e']
247
248
        if cursor:
249
            cursor.close()
250
        if cnx:
251
            cnx.disconnect()
252
253
        ################################################################################################################
254
        # Step 5: query parameters data
255
        ################################################################################################################
256
        parameters = dict()
257
        parameters['names'] = list()
258
        parameters['timestamps'] = list()
259
        parameters['values'] = list()
260
261
        tariff_dict = utilities.get_energy_category_tariffs(offline_meter['cost_center_id'],
262
                                                            offline_meter['energy_category_id'],
263
                                                            reporting_start_datetime_utc,
264
                                                            reporting_end_datetime_utc)
265
        print(tariff_dict)
266
        tariff_timestamp_list = list()
267
        tariff_value_list = list()
268
        for k, v in tariff_dict.items():
269
            # convert k from utc to local
270
            k = k + timedelta(minutes=timezone_offset)
271
            tariff_timestamp_list.append(k.isoformat()[0:19])
272
            tariff_value_list.append(v)
273
274
        parameters['names'].append('TARIFF')
275
        parameters['timestamps'].append(tariff_timestamp_list)
276
        parameters['values'].append(tariff_value_list)
277
278
        ################################################################################################################
279
        # Step 6: construct the report
280
        ################################################################################################################
281
        result = {
282
            "offline_meter": {
283
                "cost_center_id": offline_meter['cost_center_id'],
284
                "energy_category_id": offline_meter['energy_category_id'],
285
                "energy_category_name": offline_meter['energy_category_name'],
286
                "unit_of_measure": offline_meter['unit_of_measure'],
287
                "kgce": offline_meter['kgce'],
288
                "kgco2e": offline_meter['kgco2e'],
289
            },
290
            "reporting_period": {
291
                "increment_rate":
292
                    (reporting['total_in_category'] - base['total_in_category'])/base['total_in_category']
293
                    if base['total_in_category'] > 0 else None,
294
                "total_in_category": reporting['total_in_category'],
295
                "total_in_kgce": reporting['total_in_kgce'],
296
                "total_in_kgco2e": reporting['total_in_kgco2e'],
297
                "timestamps": [reporting['timestamps'],
298
                               reporting['timestamps'],
299
                               reporting['timestamps']],
300
                "values": [reporting['values_in_category'],
301
                           reporting['values_in_kgce'],
302
                           reporting['values_in_kgco2e']],
303
            },
304
            "base_period": {
305
                "total_in_category": base['total_in_category'],
306
                "total_in_kgce": base['total_in_kgce'],
307
                "total_in_kgco2e": base['total_in_kgco2e'],
308
                "timestamps": [base['timestamps'],
309
                               base['timestamps'],
310
                               base['timestamps']],
311
                "values": [base['values_in_category'],
312
                           base['values_in_kgce'],
313
                           base['values_in_kgco2e']],
314
            },
315
            "parameters": {
316
                "names": parameters['names'],
317
                "timestamps": parameters['timestamps'],
318
                "values": parameters['values']
319
            },
320
        }
321
322
        resp.body = json.dumps(result)
323