reports.virtualmetercost.Reporting.__init__() - Code Metrics - myems/myems-api - Measure and Improve Code Quality continuously with Scrutinizer

reports.virtualmetercost.Reporting.init() A
last analyzed 2021-02-26 06:13 UTC

↳ Parent: reports.virtualmetercost

Complexity

Conditions

Size

Total Lines	3
Code Lines	3

Duplication

Lines	3
Ratio	100 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nop	0
dl	3
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
from core import utilities
from decimal import Decimal
import excelexporters.virtualmetercost


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 virtual meter and energy category
    # Step 3: query base period energy consumption
    # Step 4: query base period energy cost
    # Step 5: query reporting period energy consumption
    # Step 6: query reporting period energy cost
    # Step 7: query tariff data
    # Step 8: construct the report
    ####################################################################################################################
    @staticmethod
    def on_get(req, resp):
        print(req.params)
        virtual_meter_id = req.params.get('virtualmeterid')
        period_type = req.params.get('periodtype')
        base_period_start_datetime_local = req.params.get('baseperiodstartdatetime')
        base_period_end_datetime_local = req.params.get('baseperiodenddatetime')
        reporting_period_start_datetime_local = req.params.get('reportingperiodstartdatetime')
        reporting_period_end_datetime_local = req.params.get('reportingperiodenddatetime')

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

        if period_type is None:
            raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_PERIOD_TYPE')
        else:
            period_type = str.strip(period_type)
            if period_type not in ['hourly', 'daily', 'monthly', 'yearly']:
                raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_PERIOD_TYPE')

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

        base_start_datetime_utc = None
        if base_period_start_datetime_local is not None and len(str.strip(base_period_start_datetime_local)) > 0:
            base_period_start_datetime_local = str.strip(base_period_start_datetime_local)
            try:
                base_start_datetime_utc = datetime.strptime(base_period_start_datetime_local, '%Y-%m-%dT%H:%M:%S')
            except ValueError:
                raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
                                       description="API.INVALID_BASE_PERIOD_START_DATETIME")
            base_start_datetime_utc = base_start_datetime_utc.replace(tzinfo=timezone.utc) - \
                timedelta(minutes=timezone_offset)

        base_end_datetime_utc = None
        if base_period_end_datetime_local is not None and len(str.strip(base_period_end_datetime_local)) > 0:
            base_period_end_datetime_local = str.strip(base_period_end_datetime_local)
            try:
                base_end_datetime_utc = datetime.strptime(base_period_end_datetime_local, '%Y-%m-%dT%H:%M:%S')
            except ValueError:
                raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
                                       description="API.INVALID_BASE_PERIOD_END_DATETIME")
            base_end_datetime_utc = base_end_datetime_utc.replace(tzinfo=timezone.utc) - \
                timedelta(minutes=timezone_offset)

        if base_start_datetime_utc is not None and base_end_datetime_utc is not None and \
                base_start_datetime_utc >= base_end_datetime_utc:
            raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
                                   description='API.INVALID_BASE_PERIOD_END_DATETIME')

        if reporting_period_start_datetime_local is None:
            raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
                                   description="API.INVALID_REPORTING_PERIOD_START_DATETIME")
        else:
            reporting_period_start_datetime_local = str.strip(reporting_period_start_datetime_local)
            try:
                reporting_start_datetime_utc = datetime.strptime(reporting_period_start_datetime_local,
                                                                 '%Y-%m-%dT%H:%M:%S')
            except ValueError:
                raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
                                       description="API.INVALID_REPORTING_PERIOD_START_DATETIME")
            reporting_start_datetime_utc = reporting_start_datetime_utc.replace(tzinfo=timezone.utc) - \
                timedelta(minutes=timezone_offset)

        if reporting_period_end_datetime_local is None:
            raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
                                   description="API.INVALID_REPORTING_PERIOD_END_DATETIME")
        else:
            reporting_period_end_datetime_local = str.strip(reporting_period_end_datetime_local)
            try:
                reporting_end_datetime_utc = datetime.strptime(reporting_period_end_datetime_local,
                                                               '%Y-%m-%dT%H:%M:%S')
            except ValueError:
                raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
                                       description="API.INVALID_REPORTING_PERIOD_END_DATETIME")
            reporting_end_datetime_utc = reporting_end_datetime_utc.replace(tzinfo=timezone.utc) - \
                timedelta(minutes=timezone_offset)

        if reporting_start_datetime_utc >= reporting_end_datetime_utc:
            raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
                                   description='API.INVALID_REPORTING_PERIOD_END_DATETIME')

        ################################################################################################################
        # Step 2: query the virtual meter and energy category
        ################################################################################################################
        cnx_system = mysql.connector.connect(**config.myems_system_db)
        cursor_system = cnx_system.cursor()

        cnx_energy = mysql.connector.connect(**config.myems_energy_db)
        cursor_energy = cnx_energy.cursor()

        cnx_billing = mysql.connector.connect(**config.myems_billing_db)
        cursor_billing = cnx_billing.cursor()

        cursor_system.execute(" SELECT m.id, m.name, m.cost_center_id, m.energy_category_id, "
                              "        ec.name, ec.unit_of_measure, ec.kgce, ec.kgco2e "
                              " FROM tbl_virtual_meters m, tbl_energy_categories ec "
                              " WHERE m.id = %s AND m.energy_category_id = ec.id ", (virtual_meter_id,))
        row_virtual_meter = cursor_system.fetchone()
        if row_virtual_meter is None:
            if cursor_system:
                cursor_system.close()
            if cnx_system:
                cnx_system.disconnect()

            if cursor_energy:
                cursor_energy.close()
            if cnx_energy:
                cnx_energy.disconnect()

            if cursor_billing:
                cursor_billing.close()
            if cnx_billing:
                cnx_billing.disconnect()
            raise falcon.HTTPError(falcon.HTTP_404, title='API.NOT_FOUND', description='API.VIRTUAL_METER_NOT_FOUND')

        virtual_meter = dict()
        virtual_meter['id'] = row_virtual_meter[0]
        virtual_meter['name'] = row_virtual_meter[1]
        virtual_meter['cost_center_id'] = row_virtual_meter[2]
        virtual_meter['energy_category_id'] = row_virtual_meter[3]
        virtual_meter['energy_category_name'] = row_virtual_meter[4]
        virtual_meter['unit_of_measure'] = config.currency_unit
        virtual_meter['kgce'] = row_virtual_meter[6]
        virtual_meter['kgco2e'] = row_virtual_meter[7]

        ################################################################################################################
        # Step 3: query base period energy consumption
        ################################################################################################################
        query = (" SELECT start_datetime_utc, actual_value "
                 " FROM tbl_virtual_meter_hourly "
                 " WHERE virtual_meter_id = %s "
                 " AND start_datetime_utc >= %s "
                 " AND start_datetime_utc < %s "
                 " ORDER BY start_datetime_utc ")
        cursor_energy.execute(query, (virtual_meter['id'], base_start_datetime_utc, base_end_datetime_utc))
        rows_virtual_meter_hourly = cursor_energy.fetchall()

        rows_virtual_meter_periodically = utilities.aggregate_hourly_data_by_period(rows_virtual_meter_hourly,
                                                                                    base_start_datetime_utc,
                                                                                    base_end_datetime_utc,
                                                                                    period_type)
        base = dict()
        base['timestamps'] = list()
        base['values'] = list()
        base['total_in_category'] = Decimal(0.0)
        base['total_in_kgce'] = Decimal(0.0)
        base['total_in_kgco2e'] = Decimal(0.0)

        for row_virtual_meter_periodically in rows_virtual_meter_periodically:
            current_datetime_local = row_virtual_meter_periodically[0].replace(tzinfo=timezone.utc) + \
                                     timedelta(minutes=timezone_offset)
            if period_type == 'hourly':
                current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
            elif period_type == 'daily':
                current_datetime = current_datetime_local.strftime('%Y-%m-%d')
            elif period_type == 'monthly':
                current_datetime = current_datetime_local.strftime('%Y-%m')
            elif period_type == 'yearly':
                current_datetime = current_datetime_local.strftime('%Y')

            actual_value = Decimal(0.0) if row_virtual_meter_periodically[1] is None \
                else row_virtual_meter_periodically[1]
            base['timestamps'].append(current_datetime)

            base['total_in_kgce'] += actual_value * virtual_meter['kgce']
            base['total_in_kgco2e'] += actual_value * virtual_meter['kgco2e']

        ################################################################################################################
        # Step 4: query base period energy cost
        ################################################################################################################
        query = (" SELECT start_datetime_utc, actual_value "
                 " FROM tbl_virtual_meter_hourly "
                 " WHERE virtual_meter_id = %s "
                 " AND start_datetime_utc >= %s "
                 " AND start_datetime_utc < %s "
                 " ORDER BY start_datetime_utc ")
        cursor_billing.execute(query, (virtual_meter['id'], base_start_datetime_utc, base_end_datetime_utc))
        rows_virtual_meter_hourly = cursor_billing.fetchall()

        rows_virtual_meter_periodically = utilities.aggregate_hourly_data_by_period(rows_virtual_meter_hourly,
                                                                                    base_start_datetime_utc,
                                                                                    base_end_datetime_utc,
                                                                                    period_type)

        base['values'] = list()
        base['total_in_category'] = Decimal(0.0)

        for row_virtual_meter_periodically in rows_virtual_meter_periodically:
            actual_value = Decimal(0.0) if row_virtual_meter_periodically[1] is None \
                else row_virtual_meter_periodically[1]
            base['values'].append(actual_value)
            base['total_in_category'] += actual_value

        ################################################################################################################
        # Step 5: query reporting period energy consumption
        ################################################################################################################
        query = (" SELECT start_datetime_utc, actual_value "
                 " FROM tbl_virtual_meter_hourly "
                 " WHERE virtual_meter_id = %s "
                 " AND start_datetime_utc >= %s "
                 " AND start_datetime_utc < %s "
                 " ORDER BY start_datetime_utc ")
        cursor_billing.execute(query, (virtual_meter['id'], reporting_start_datetime_utc, reporting_end_datetime_utc))
        rows_virtual_meter_hourly = cursor_billing.fetchall()

        rows_virtual_meter_periodically = utilities.aggregate_hourly_data_by_period(rows_virtual_meter_hourly,
                                                                                    reporting_start_datetime_utc,
                                                                                    reporting_end_datetime_utc,
                                                                                    period_type)
        reporting = dict()
        reporting['timestamps'] = list()
        reporting['values'] = list()
        reporting['total_in_category'] = Decimal(0.0)
        reporting['total_in_kgce'] = Decimal(0.0)
        reporting['total_in_kgco2e'] = Decimal(0.0)

        for row_virtual_meter_periodically in rows_virtual_meter_periodically:
            current_datetime_local = row_virtual_meter_periodically[0].replace(tzinfo=timezone.utc) + \
                                     timedelta(minutes=timezone_offset)
            if period_type == 'hourly':
                current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
            elif period_type == 'daily':
                current_datetime = current_datetime_local.strftime('%Y-%m-%d')
            elif period_type == 'monthly':
                current_datetime = current_datetime_local.strftime('%Y-%m')
            elif period_type == 'yearly':
                current_datetime = current_datetime_local.strftime('%Y')

            actual_value = Decimal(0.0) if row_virtual_meter_periodically[1] is None \
                else row_virtual_meter_periodically[1]

            reporting['timestamps'].append(current_datetime)
            reporting['total_in_kgce'] += actual_value * virtual_meter['kgce']
            reporting['total_in_kgco2e'] += actual_value * virtual_meter['kgco2e']

        ################################################################################################################
        # Step 6: query reporting period energy cost
        ################################################################################################################
        query = (" SELECT start_datetime_utc, actual_value "
                 " FROM tbl_virtual_meter_hourly "
                 " WHERE virtual_meter_id = %s "
                 " AND start_datetime_utc >= %s "
                 " AND start_datetime_utc < %s "
                 " ORDER BY start_datetime_utc ")
        cursor_billing.execute(query, (virtual_meter['id'], reporting_start_datetime_utc, reporting_end_datetime_utc))
        rows_virtual_meter_hourly = cursor_billing.fetchall()

        rows_virtual_meter_periodically = utilities.aggregate_hourly_data_by_period(rows_virtual_meter_hourly,
                                                                                    reporting_start_datetime_utc,
                                                                                    reporting_end_datetime_utc,
                                                                                    period_type)

        for row_virtual_meter_periodically in rows_virtual_meter_periodically:
            actual_value = Decimal(0.0) if row_virtual_meter_periodically[1] is None \
                else row_virtual_meter_periodically[1]

            reporting['values'].append(actual_value)
            reporting['total_in_category'] += actual_value

        ################################################################################################################
        # Step 7: query tariff data
        ################################################################################################################
        parameters_data = dict()
        parameters_data['names'] = list()
        parameters_data['timestamps'] = list()
        parameters_data['values'] = list()

        tariff_dict = utilities.get_energy_category_tariffs(virtual_meter['cost_center_id'],
                                                            virtual_meter['energy_category_id'],
                                                            reporting_start_datetime_utc,
                                                            reporting_end_datetime_utc)
        tariff_timestamp_list = list()
        tariff_value_list = list()
        for k, v in tariff_dict.items():
            # convert k from utc to local
            k = k + timedelta(minutes=timezone_offset)
            tariff_timestamp_list.append(k.isoformat()[0:19])
            tariff_value_list.append(v)

        parameters_data['names'].append('TARIFF-' + virtual_meter['energy_category_name'])
        parameters_data['timestamps'].append(tariff_timestamp_list)
        parameters_data['values'].append(tariff_value_list)

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

        if cursor_energy:
            cursor_energy.close()
        if cnx_energy:
            cnx_energy.disconnect()

        if cursor_billing:
            cursor_billing.close()
        if cnx_billing:
            cnx_billing.disconnect()

        result = {
            "virtual_meter": {
                "cost_center_id": virtual_meter['cost_center_id'],
                "energy_category_id": virtual_meter['energy_category_id'],
                "energy_category_name": virtual_meter['energy_category_name'],
                "unit_of_measure": config.currency_unit,
                "kgce": virtual_meter['kgce'],
                "kgco2e": virtual_meter['kgco2e'],
            },
            "base_period": {
                "total_in_category": base['total_in_category'],
                "total_in_kgce": base['total_in_kgce'],
                "total_in_kgco2e": base['total_in_kgco2e'],
                "timestamps": base['timestamps'],
                "values": base['values'],
            },
            "reporting_period": {
                "increment_rate":
                    (reporting['total_in_category'] - base['total_in_category']) / base['total_in_category']
                    if base['total_in_category'] > 0 else None,
                "total_in_category": reporting['total_in_category'],
                "total_in_kgce": reporting['total_in_kgce'],
                "total_in_kgco2e": reporting['total_in_kgco2e'],
                "timestamps": reporting['timestamps'],
                "values": reporting['values'],
            },
            "parameters": {
                "names": parameters_data['names'],
                "timestamps": parameters_data['timestamps'],
                "values": parameters_data['values']
            },
        }

        # export result to Excel file and then encode the file to base64 string
        result['excel_bytes_base64'] = \
            excelexporters.virtualmetercost.export(result,
                                                   virtual_meter['name'],
                                                   reporting_period_start_datetime_local,
                                                   reporting_period_end_datetime_local,
                                                   period_type)

        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		from core import utilities
7		from decimal import Decimal
8		import excelexporters.virtualmetercost
9
10
11	View Code Duplication	class Reporting:
		0 ignored issues – show Duplication introduced 2021-01-27 05:25 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
12		@staticmethod
13		def __init__():
14		pass
15
16		@staticmethod
17		def on_options(req, resp):
18		resp.status = falcon.HTTP_200
19
20		####################################################################################################################
21		# PROCEDURES
22		# Step 1: valid parameters
23		# Step 2: query the virtual meter and energy category
24		# Step 3: query base period energy consumption
25		# Step 4: query base period energy cost
26		# Step 5: query reporting period energy consumption
27		# Step 6: query reporting period energy cost
28		# Step 7: query tariff data
29		# Step 8: construct the report
30		####################################################################################################################
31		@staticmethod
32		def on_get(req, resp):
33		print(req.params)
34		virtual_meter_id = req.params.get('virtualmeterid')
35		period_type = req.params.get('periodtype')
36		base_period_start_datetime_local = req.params.get('baseperiodstartdatetime')
37		base_period_end_datetime_local = req.params.get('baseperiodenddatetime')
38		reporting_period_start_datetime_local = req.params.get('reportingperiodstartdatetime')
39		reporting_period_end_datetime_local = req.params.get('reportingperiodenddatetime')
40
41		################################################################################################################
42		# Step 1: valid parameters
43		################################################################################################################
44		if virtual_meter_id is None:
45		raise falcon.HTTPError(falcon.HTTP_400,
46		title='API.BAD_REQUEST',
47		description='API.INVALID_VIRTUAL_METER_ID')
48		else:
49		virtual_meter_id = str.strip(virtual_meter_id)
50		if not virtual_meter_id.isdigit() or int(virtual_meter_id) <= 0:
51		raise falcon.HTTPError(falcon.HTTP_400,
52		title='API.BAD_REQUEST',
53		description='API.INVALID_VIRTUAL_METER_ID')
54
55		if period_type is None:
56		raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_PERIOD_TYPE')
57		else:
58		period_type = str.strip(period_type)
59		if period_type not in ['hourly', 'daily', 'monthly', 'yearly']:
60		raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_PERIOD_TYPE')
61
62		timezone_offset = int(config.utc_offset[1:3]) * 60 + int(config.utc_offset[4:6])
63		if config.utc_offset[0] == '-':
64		timezone_offset = -timezone_offset
65
66		base_start_datetime_utc = None
67		if base_period_start_datetime_local is not None and len(str.strip(base_period_start_datetime_local)) > 0:
68		base_period_start_datetime_local = str.strip(base_period_start_datetime_local)
69		try:
70		base_start_datetime_utc = datetime.strptime(base_period_start_datetime_local, '%Y-%m-%dT%H:%M:%S')
71		except ValueError:
72		raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
73		description="API.INVALID_BASE_PERIOD_START_DATETIME")
74		base_start_datetime_utc = base_start_datetime_utc.replace(tzinfo=timezone.utc) - \
75		timedelta(minutes=timezone_offset)
76
77		base_end_datetime_utc = None
78		if base_period_end_datetime_local is not None and len(str.strip(base_period_end_datetime_local)) > 0:
79		base_period_end_datetime_local = str.strip(base_period_end_datetime_local)
80		try:
81		base_end_datetime_utc = datetime.strptime(base_period_end_datetime_local, '%Y-%m-%dT%H:%M:%S')
82		except ValueError:
83		raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
84		description="API.INVALID_BASE_PERIOD_END_DATETIME")
85		base_end_datetime_utc = base_end_datetime_utc.replace(tzinfo=timezone.utc) - \
86		timedelta(minutes=timezone_offset)
87
88		if base_start_datetime_utc is not None and base_end_datetime_utc is not None and \
89		base_start_datetime_utc >= base_end_datetime_utc:
90		raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
91		description='API.INVALID_BASE_PERIOD_END_DATETIME')
92
93		if reporting_period_start_datetime_local is None:
94		raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
95		description="API.INVALID_REPORTING_PERIOD_START_DATETIME")
96		else:
97		reporting_period_start_datetime_local = str.strip(reporting_period_start_datetime_local)
98		try:
99		reporting_start_datetime_utc = datetime.strptime(reporting_period_start_datetime_local,
100		'%Y-%m-%dT%H:%M:%S')
101		except ValueError:
102		raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
103		description="API.INVALID_REPORTING_PERIOD_START_DATETIME")
104		reporting_start_datetime_utc = reporting_start_datetime_utc.replace(tzinfo=timezone.utc) - \
105		timedelta(minutes=timezone_offset)
106
107		if reporting_period_end_datetime_local is None:
108		raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
109		description="API.INVALID_REPORTING_PERIOD_END_DATETIME")
110		else:
111		reporting_period_end_datetime_local = str.strip(reporting_period_end_datetime_local)
112		try:
113		reporting_end_datetime_utc = datetime.strptime(reporting_period_end_datetime_local,
114		'%Y-%m-%dT%H:%M:%S')
115		except ValueError:
116		raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
117		description="API.INVALID_REPORTING_PERIOD_END_DATETIME")
118		reporting_end_datetime_utc = reporting_end_datetime_utc.replace(tzinfo=timezone.utc) - \
119		timedelta(minutes=timezone_offset)
120
121		if reporting_start_datetime_utc >= reporting_end_datetime_utc:
122		raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
123		description='API.INVALID_REPORTING_PERIOD_END_DATETIME')
124
125		################################################################################################################
126		# Step 2: query the virtual meter and energy category
127		################################################################################################################
128		cnx_system = mysql.connector.connect(**config.myems_system_db)
129		cursor_system = cnx_system.cursor()
130
131		cnx_energy = mysql.connector.connect(**config.myems_energy_db)
132		cursor_energy = cnx_energy.cursor()
133
134		cnx_billing = mysql.connector.connect(**config.myems_billing_db)
135		cursor_billing = cnx_billing.cursor()
136
137		cursor_system.execute(" SELECT m.id, m.name, m.cost_center_id, m.energy_category_id, "
138		" ec.name, ec.unit_of_measure, ec.kgce, ec.kgco2e "
139		" FROM tbl_virtual_meters m, tbl_energy_categories ec "
140		" WHERE m.id = %s AND m.energy_category_id = ec.id ", (virtual_meter_id,))
141		row_virtual_meter = cursor_system.fetchone()
142		if row_virtual_meter is None:
143		if cursor_system:
144		cursor_system.close()
145		if cnx_system:
146		cnx_system.disconnect()
147
148		if cursor_energy:
149		cursor_energy.close()
150		if cnx_energy:
151		cnx_energy.disconnect()
152
153		if cursor_billing:
154		cursor_billing.close()
155		if cnx_billing:
156		cnx_billing.disconnect()
157		raise falcon.HTTPError(falcon.HTTP_404, title='API.NOT_FOUND', description='API.VIRTUAL_METER_NOT_FOUND')
158
159		virtual_meter = dict()
160		virtual_meter['id'] = row_virtual_meter[0]
161		virtual_meter['name'] = row_virtual_meter[1]
162		virtual_meter['cost_center_id'] = row_virtual_meter[2]
163		virtual_meter['energy_category_id'] = row_virtual_meter[3]
164		virtual_meter['energy_category_name'] = row_virtual_meter[4]
165		virtual_meter['unit_of_measure'] = config.currency_unit
166		virtual_meter['kgce'] = row_virtual_meter[6]
167		virtual_meter['kgco2e'] = row_virtual_meter[7]
168
169		################################################################################################################
170		# Step 3: query base period energy consumption
171		################################################################################################################
172		query = (" SELECT start_datetime_utc, actual_value "
173		" FROM tbl_virtual_meter_hourly "
174		" WHERE virtual_meter_id = %s "
175		" AND start_datetime_utc >= %s "
176		" AND start_datetime_utc < %s "
177		" ORDER BY start_datetime_utc ")
178		cursor_energy.execute(query, (virtual_meter['id'], base_start_datetime_utc, base_end_datetime_utc))
179		rows_virtual_meter_hourly = cursor_energy.fetchall()
180
181		rows_virtual_meter_periodically = utilities.aggregate_hourly_data_by_period(rows_virtual_meter_hourly,
182		base_start_datetime_utc,
183		base_end_datetime_utc,
184		period_type)
185		base = dict()
186		base['timestamps'] = list()
187		base['values'] = list()
188		base['total_in_category'] = Decimal(0.0)
189		base['total_in_kgce'] = Decimal(0.0)
190		base['total_in_kgco2e'] = Decimal(0.0)
191
192		for row_virtual_meter_periodically in rows_virtual_meter_periodically:
193		current_datetime_local = row_virtual_meter_periodically[0].replace(tzinfo=timezone.utc) + \
194		timedelta(minutes=timezone_offset)
195		if period_type == 'hourly':
196		current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
197		elif period_type == 'daily':
198		current_datetime = current_datetime_local.strftime('%Y-%m-%d')
199		elif period_type == 'monthly':
200		current_datetime = current_datetime_local.strftime('%Y-%m')
201		elif period_type == 'yearly':
202		current_datetime = current_datetime_local.strftime('%Y')
203
204		actual_value = Decimal(0.0) if row_virtual_meter_periodically[1] is None \
205		else row_virtual_meter_periodically[1]
206		base['timestamps'].append(current_datetime)
		0 ignored issues – show introduced 2020-11-24 10:14 UTC by Report Bug Copy Issue Report The variable `current_datetime` does not seem to be defined for all execution paths. Loading history...
207		base['total_in_kgce'] += actual_value * virtual_meter['kgce']
208		base['total_in_kgco2e'] += actual_value * virtual_meter['kgco2e']
209
210		################################################################################################################
211		# Step 4: query base period energy cost
212		################################################################################################################
213		query = (" SELECT start_datetime_utc, actual_value "
214		" FROM tbl_virtual_meter_hourly "
215		" WHERE virtual_meter_id = %s "
216		" AND start_datetime_utc >= %s "
217		" AND start_datetime_utc < %s "
218		" ORDER BY start_datetime_utc ")
219		cursor_billing.execute(query, (virtual_meter['id'], base_start_datetime_utc, base_end_datetime_utc))
220		rows_virtual_meter_hourly = cursor_billing.fetchall()
221
222		rows_virtual_meter_periodically = utilities.aggregate_hourly_data_by_period(rows_virtual_meter_hourly,
223		base_start_datetime_utc,
224		base_end_datetime_utc,
225		period_type)
226
227		base['values'] = list()
228		base['total_in_category'] = Decimal(0.0)
229
230		for row_virtual_meter_periodically in rows_virtual_meter_periodically:
231		actual_value = Decimal(0.0) if row_virtual_meter_periodically[1] is None \
232		else row_virtual_meter_periodically[1]
233		base['values'].append(actual_value)
234		base['total_in_category'] += actual_value
235
236		################################################################################################################
237		# Step 5: query reporting period energy consumption
238		################################################################################################################
239		query = (" SELECT start_datetime_utc, actual_value "
240		" FROM tbl_virtual_meter_hourly "
241		" WHERE virtual_meter_id = %s "
242		" AND start_datetime_utc >= %s "
243		" AND start_datetime_utc < %s "
244		" ORDER BY start_datetime_utc ")
245		cursor_billing.execute(query, (virtual_meter['id'], reporting_start_datetime_utc, reporting_end_datetime_utc))
246		rows_virtual_meter_hourly = cursor_billing.fetchall()
247
248		rows_virtual_meter_periodically = utilities.aggregate_hourly_data_by_period(rows_virtual_meter_hourly,
249		reporting_start_datetime_utc,
250		reporting_end_datetime_utc,
251		period_type)
252		reporting = dict()
253		reporting['timestamps'] = list()
254		reporting['values'] = list()
255		reporting['total_in_category'] = Decimal(0.0)
256		reporting['total_in_kgce'] = Decimal(0.0)
257		reporting['total_in_kgco2e'] = Decimal(0.0)
258
259		for row_virtual_meter_periodically in rows_virtual_meter_periodically:
260		current_datetime_local = row_virtual_meter_periodically[0].replace(tzinfo=timezone.utc) + \
261		timedelta(minutes=timezone_offset)
262		if period_type == 'hourly':
263		current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
264		elif period_type == 'daily':
265		current_datetime = current_datetime_local.strftime('%Y-%m-%d')
266		elif period_type == 'monthly':
267		current_datetime = current_datetime_local.strftime('%Y-%m')
268		elif period_type == 'yearly':
269		current_datetime = current_datetime_local.strftime('%Y')
270
271		actual_value = Decimal(0.0) if row_virtual_meter_periodically[1] is None \
272		else row_virtual_meter_periodically[1]
273
274		reporting['timestamps'].append(current_datetime)
275		reporting['total_in_kgce'] += actual_value * virtual_meter['kgce']
276		reporting['total_in_kgco2e'] += actual_value * virtual_meter['kgco2e']
277
278		################################################################################################################
279		# Step 6: query reporting period energy cost
280		################################################################################################################
281		query = (" SELECT start_datetime_utc, actual_value "
282		" FROM tbl_virtual_meter_hourly "
283		" WHERE virtual_meter_id = %s "
284		" AND start_datetime_utc >= %s "
285		" AND start_datetime_utc < %s "
286		" ORDER BY start_datetime_utc ")
287		cursor_billing.execute(query, (virtual_meter['id'], reporting_start_datetime_utc, reporting_end_datetime_utc))
288		rows_virtual_meter_hourly = cursor_billing.fetchall()
289
290		rows_virtual_meter_periodically = utilities.aggregate_hourly_data_by_period(rows_virtual_meter_hourly,
291		reporting_start_datetime_utc,
292		reporting_end_datetime_utc,
293		period_type)
294
295		for row_virtual_meter_periodically in rows_virtual_meter_periodically:
296		actual_value = Decimal(0.0) if row_virtual_meter_periodically[1] is None \
297		else row_virtual_meter_periodically[1]
298
299		reporting['values'].append(actual_value)
300		reporting['total_in_category'] += actual_value
301
302		################################################################################################################
303		# Step 7: query tariff data
304		################################################################################################################
305		parameters_data = dict()
306		parameters_data['names'] = list()
307		parameters_data['timestamps'] = list()
308		parameters_data['values'] = list()
309
310		tariff_dict = utilities.get_energy_category_tariffs(virtual_meter['cost_center_id'],
311		virtual_meter['energy_category_id'],
312		reporting_start_datetime_utc,
313		reporting_end_datetime_utc)
314		tariff_timestamp_list = list()
315		tariff_value_list = list()
316		for k, v in tariff_dict.items():
317		# convert k from utc to local
318		k = k + timedelta(minutes=timezone_offset)
319		tariff_timestamp_list.append(k.isoformat()[0:19])
320		tariff_value_list.append(v)
321
322		parameters_data['names'].append('TARIFF-' + virtual_meter['energy_category_name'])
323		parameters_data['timestamps'].append(tariff_timestamp_list)
324		parameters_data['values'].append(tariff_value_list)
325
326		################################################################################################################
327		# Step 8: construct the report
328		################################################################################################################
329		if cursor_system:
330		cursor_system.close()
331		if cnx_system:
332		cnx_system.disconnect()
333
334		if cursor_energy:
335		cursor_energy.close()
336		if cnx_energy:
337		cnx_energy.disconnect()
338
339		if cursor_billing:
340		cursor_billing.close()
341		if cnx_billing:
342		cnx_billing.disconnect()
343
344		result = {
345		"virtual_meter": {
346		"cost_center_id": virtual_meter['cost_center_id'],
347		"energy_category_id": virtual_meter['energy_category_id'],
348		"energy_category_name": virtual_meter['energy_category_name'],
349		"unit_of_measure": config.currency_unit,
350		"kgce": virtual_meter['kgce'],
351		"kgco2e": virtual_meter['kgco2e'],
352		},
353		"base_period": {
354		"total_in_category": base['total_in_category'],
355		"total_in_kgce": base['total_in_kgce'],
356		"total_in_kgco2e": base['total_in_kgco2e'],
357		"timestamps": base['timestamps'],
358		"values": base['values'],
359		},
360		"reporting_period": {
361		"increment_rate":
362		(reporting['total_in_category'] - base['total_in_category']) / base['total_in_category']
363		if base['total_in_category'] > 0 else None,
364		"total_in_category": reporting['total_in_category'],
365		"total_in_kgce": reporting['total_in_kgce'],
366		"total_in_kgco2e": reporting['total_in_kgco2e'],
367		"timestamps": reporting['timestamps'],
368		"values": reporting['values'],
369		},
370		"parameters": {
371		"names": parameters_data['names'],
372		"timestamps": parameters_data['timestamps'],
373		"values": parameters_data['values']
374		},
375		}
376
377		# export result to Excel file and then encode the file to base64 string
378		result['excel_bytes_base64'] = \
379		excelexporters.virtualmetercost.export(result,
380		virtual_meter['name'],
381		reporting_period_start_datetime_local,
382		reporting_period_end_datetime_local,
383		period_type)
384
385		resp.body = json.dumps(result)
386

myems / myems-api

reports.virtualmetercost.Reporting.__init__() A last analyzed 2021-02-26 06:13 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

reports.virtualmetercost.Reporting.init() A
last analyzed 2021-02-26 06:13 UTC