|
1
|
|
|
""" |
|
2
|
|
|
Class Parameter Handling |
|
3
|
|
|
|
|
4
|
|
|
Facilitates handling parameters values |
|
5
|
|
|
""" |
|
6
|
|
|
# package to handle date and times |
|
7
|
|
|
from datetime import datetime, timedelta |
|
8
|
|
|
# package to allow year and/or month operations based on a reference date |
|
9
|
|
|
import datedelta |
|
10
|
|
|
# package to add support for multi-language (i18n) |
|
11
|
|
|
import gettext |
|
12
|
|
|
# package to perform mathematical operations |
|
13
|
|
|
import math |
|
14
|
|
|
# package to handle files/folders and related metadata/operations |
|
15
|
|
|
import os |
|
16
|
|
|
# package regular expressions |
|
17
|
|
|
import re |
|
18
|
|
|
|
|
19
|
|
|
|
|
20
|
|
|
class ParameterHandling: |
|
21
|
|
|
known_expressions = { |
|
22
|
|
|
'year': ['CY', 'CurrentYear'], |
|
23
|
|
|
'semester': ['CYCS', 'CurrentYearCurrentSemester'], |
|
24
|
|
|
'semester_week': ['CYCSCW', 'CurrentYearCurrentSemesterCurrentWeek'], |
|
25
|
|
|
'just_semester': ['CS', 'CurrentSemester'], |
|
26
|
|
|
'quarter': ['CYCQ', 'CurrentYearCurrentQuarter'], |
|
27
|
|
|
'quarter_week': ['CYCQCW', 'CurrentYearCurrentQuarterCurrentWeek'], |
|
28
|
|
|
'just_quarter': ['CQ', 'CurrentQuarter'], |
|
29
|
|
|
'fiscal_period': ['CYCFP', 'CurrentYearCurrentFiscalPeriod'], |
|
30
|
|
|
'just_fiscal_period': ['CFP', 'FiscalPeriod'], |
|
31
|
|
|
'month': ['CYCM', 'CurrentYearCurrentMonth'], |
|
32
|
|
|
'just_month': ['CM', 'CurrentMonth'], |
|
33
|
|
|
'week': ['CYCW', 'CurrentYearCurrentWeek'], |
|
34
|
|
|
'just_week': ['CW', 'CurrentWeek'], |
|
35
|
|
|
'day': ['CYCMCD', 'CurrentYearCurrentMonthCurrentDay'], |
|
36
|
|
|
'just_day': ['CD', 'CurrentDay'], |
|
37
|
|
|
'hour': ['CYCMCDCH', 'CurrentYearCurrentMonthCurrentDayCurrentHour'], |
|
38
|
|
|
} |
|
39
|
|
|
output_standard_formats = { |
|
40
|
|
|
'year': '%Y', |
|
41
|
|
|
'fiscal_period': '%Y0%m', |
|
42
|
|
|
'just_fiscal_period': '0%m', |
|
43
|
|
|
'month': '%Y%m', |
|
44
|
|
|
'just_month': '%m', |
|
45
|
|
|
'day': '%Y%m%d', |
|
46
|
|
|
'just_day': '%d', |
|
47
|
|
|
'hour': '%Y%m%d%H%M%S%f', |
|
48
|
|
|
} |
|
49
|
|
|
locale = None |
|
50
|
|
|
|
|
51
|
|
|
def __init__(self, in_language='en_US'): |
|
52
|
|
|
file_parts = os.path.normpath(os.path.abspath(__file__)).replace('\\', os.path.altsep) \ |
|
53
|
|
|
.split(os.path.altsep) |
|
54
|
|
|
locale_domain = file_parts[(len(file_parts) - 1)].replace('.py', '') |
|
55
|
|
|
locale_folder = os.path.normpath(os.path.join( |
|
56
|
|
|
os.path.join(os.path.altsep.join(file_parts[:-2]), 'project_locale'), locale_domain)) |
|
57
|
|
|
self.locale = gettext.translation(locale_domain, localedir=locale_folder, |
|
58
|
|
|
languages=[in_language], fallback=True) |
|
59
|
|
|
|
|
60
|
|
|
def build_parameters(self, local_logger, query_session_parameters, in_parameter_rules |
|
61
|
|
|
, in_start_iso_weekday): |
|
62
|
|
|
local_logger.debug(self.locale.gettext('Seen Parameters are: {parameters}') |
|
63
|
|
|
.replace('{parameters}', str(query_session_parameters))) |
|
64
|
|
|
parameters_type = type(query_session_parameters) |
|
65
|
|
|
local_logger.debug(self.locale.gettext('Parameters type is {parameter_type}') |
|
66
|
|
|
.replace('{parameter_type}', str(parameters_type))) |
|
67
|
|
|
tp = None |
|
68
|
|
|
if parameters_type == dict: |
|
69
|
|
|
tp = tuple(query_session_parameters.values()) |
|
70
|
|
|
elif parameters_type == list: |
|
71
|
|
|
tp = tuple(query_session_parameters) |
|
72
|
|
|
else: |
|
73
|
|
|
local_logger.error(self.locale.gettext( |
|
74
|
|
|
'Unexpected parameter type, either Dictionary or List expected, ' |
|
75
|
|
|
+ 'but seen is {parameter_type}') |
|
76
|
|
|
.replace('{parameter_type}', str(parameters_type))) |
|
77
|
|
|
exit(1) |
|
78
|
|
|
local_logger.debug(self.locale.gettext( |
|
79
|
|
|
'Initial Tuple for Parameters is: {parameters_tuple}') |
|
80
|
|
|
.replace('{parameters_tuple}', str(tp))) |
|
81
|
|
|
return self.stringify_parameters(local_logger, tp, in_parameter_rules, in_start_iso_weekday) |
|
82
|
|
|
|
|
83
|
|
|
@staticmethod |
|
84
|
|
|
def calculate_date_deviation(in_date, deviation_type, expression_parts): |
|
85
|
|
|
if expression_parts[2] is None: |
|
86
|
|
|
expression_parts[2] = 0 |
|
87
|
|
|
final_dates = { |
|
88
|
|
|
'year': in_date + datedelta.datedelta(years=int(expression_parts[2])), |
|
89
|
|
|
'semester': in_date + datedelta.datedelta(months=int(expression_parts[2]) * 6), |
|
90
|
|
|
'semester_week': in_date + timedelta(weeks=int(expression_parts[2])), |
|
91
|
|
|
'quarter': in_date + datedelta.datedelta(months=int(expression_parts[2]) * 3), |
|
92
|
|
|
'quarter_week': in_date + timedelta(weeks=int(expression_parts[2])), |
|
93
|
|
|
'fiscal_period': in_date + datedelta.datedelta(months=int(expression_parts[2])), |
|
94
|
|
|
'month': in_date + datedelta.datedelta(months=int(expression_parts[2])), |
|
95
|
|
|
'week': in_date + timedelta(weeks=int(expression_parts[2])), |
|
96
|
|
|
'day': in_date + timedelta(days=int(expression_parts[2])), |
|
97
|
|
|
'hour': in_date + timedelta(hours=int(expression_parts[2])), |
|
98
|
|
|
} |
|
99
|
|
|
return final_dates.get(deviation_type) |
|
100
|
|
|
|
|
101
|
|
|
def calculate_date_from_expression(self, local_logger, expression_parts, in_start_iso_weekday): |
|
102
|
|
|
final_string = '' |
|
103
|
|
|
all_known_expressions = self.get_flattened_known_expressions() |
|
104
|
|
|
if expression_parts[1] in all_known_expressions: |
|
105
|
|
|
str_expression = '_'.join(expression_parts) |
|
106
|
|
|
local_logger.debug(self.locale.gettext( |
|
107
|
|
|
'A known expression "{expression_parts}" has to be interpreted') |
|
108
|
|
|
.replace('{expression_parts}', str_expression)) |
|
109
|
|
|
final_string = self.interpret_known_expression( |
|
110
|
|
|
datetime.now(), expression_parts, in_start_iso_weekday) |
|
111
|
|
|
local_logger.debug(self.locale.gettext( |
|
112
|
|
|
'Known expression "{expression_parts}" has been interpreted as {final_string}') |
|
113
|
|
|
.replace('{expression_parts}', str_expression) |
|
114
|
|
|
.replace('{final_string}', final_string)) |
|
115
|
|
|
else: |
|
116
|
|
|
local_logger.debug(self.locale.gettext( |
|
117
|
|
|
'Unknown expression encountered: provided was "{given_expression}" ' |
|
118
|
|
|
+ 'which is not among known ones: "{all_known_expressions}"') |
|
119
|
|
|
.replace('{given_expression}', str(expression_parts[1])) |
|
120
|
|
|
.replace('{all_known_expressions}', |
|
121
|
|
|
'", "'.join(all_known_expressions))) |
|
122
|
|
|
exit(1) |
|
123
|
|
|
return final_string |
|
124
|
|
|
|
|
125
|
|
|
def eval_expression(self, local_logger, crt_parameter, in_start_iso_weekday): |
|
126
|
|
|
value_to_return = crt_parameter |
|
127
|
|
|
reg_ex = re.search(r'(CalculatedDate_[A-Za-z]{2,75}_*(-*)[0-9]{0,2})', crt_parameter) |
|
128
|
|
|
if reg_ex: |
|
129
|
|
|
parameter_value_parts = reg_ex.group().split('_') |
|
130
|
|
|
calculated = self.calculate_date_from_expression( |
|
131
|
|
|
local_logger, parameter_value_parts, in_start_iso_weekday) |
|
132
|
|
|
value_to_return = re.sub(reg_ex.group(), calculated, crt_parameter) |
|
133
|
|
|
local_logger.debug(self.locale.gettext( |
|
134
|
|
|
'Current Parameter is STR and has been re-interpreted as value: "{str_value}"') |
|
135
|
|
|
.replace('{str_value}', str(value_to_return))) |
|
136
|
|
|
return value_to_return |
|
137
|
|
|
|
|
138
|
|
|
def get_child_parent_expressions(self): |
|
139
|
|
|
child_parent_values = {} |
|
140
|
|
|
for current_expression_group in self.known_expressions.items(): |
|
141
|
|
|
for current_expression in current_expression_group[1]: |
|
142
|
|
|
child_parent_values[current_expression] = current_expression_group[0] |
|
143
|
|
|
return child_parent_values |
|
144
|
|
|
|
|
145
|
|
|
def get_flattened_known_expressions(self): |
|
146
|
|
|
flat_values = [] |
|
147
|
|
|
for crt_list in self.known_expressions.values(): |
|
148
|
|
|
flat_values += crt_list |
|
149
|
|
|
return flat_values |
|
150
|
|
|
|
|
151
|
|
|
@staticmethod |
|
152
|
|
|
def get_week_number_as_two_digits_string(in_date, in_start_iso_weekday=1): |
|
153
|
|
|
if in_start_iso_weekday == 7: |
|
154
|
|
|
in_date = in_date + timedelta(days=1) |
|
155
|
|
|
week_iso_num = datetime.isocalendar(in_date)[1] |
|
156
|
|
|
iso_wek_to_return = str(week_iso_num) |
|
157
|
|
|
if week_iso_num < 10: |
|
158
|
|
|
iso_wek_to_return = '0' + iso_wek_to_return |
|
159
|
|
|
return str(datetime.isocalendar(in_date)[0]), iso_wek_to_return |
|
160
|
|
|
|
|
161
|
|
|
def handle_query_parameters(self, local_logger, given_session, in_start_iso_weekday): |
|
162
|
|
|
tp = None |
|
163
|
|
|
if 'parameters' in given_session: |
|
164
|
|
|
parameter_rules = [] |
|
165
|
|
|
if 'parameters-handling-rules' in given_session: |
|
166
|
|
|
parameter_rules = given_session['parameters-handling-rules'] |
|
167
|
|
|
tp = self.build_parameters( |
|
168
|
|
|
local_logger, given_session['parameters'], parameter_rules, |
|
169
|
|
|
in_start_iso_weekday) |
|
170
|
|
|
return tp |
|
171
|
|
|
|
|
172
|
|
|
def interpret_known_expression(self, ref_date, expression_parts, in_start_iso_weekday): |
|
173
|
|
|
child_parent_expressions = self.get_child_parent_expressions() |
|
174
|
|
|
deviation_original = child_parent_expressions.get(expression_parts[1]) |
|
175
|
|
|
deviation = deviation_original.replace('just_', '') |
|
176
|
|
|
finalized_date = ref_date |
|
177
|
|
|
if len(expression_parts) > 2: |
|
178
|
|
|
finalized_date = self.calculate_date_deviation(ref_date, deviation, expression_parts) |
|
179
|
|
|
if deviation_original in ('just_semester', 'just_quarter', 'just_week', |
|
180
|
|
|
'semester', 'semester_week', 'quarter', 'quarter_week', 'week'): |
|
181
|
|
|
year_number_string, week_number_string = self.get_week_number_as_two_digits_string( |
|
182
|
|
|
finalized_date, in_start_iso_weekday) |
|
183
|
|
|
# to ensure less than 4 days within last week of year r reported to next year (ISO) |
|
184
|
|
|
semester_year_string = str(math.ceil(int(week_number_string) / 26)) |
|
185
|
|
|
quarter_string = str(min(int(week_number_string), |
|
186
|
|
|
math.ceil(int(datetime.strftime(finalized_date, '%m')) / 3))) |
|
187
|
|
|
# values pre-calculated |
|
188
|
|
|
values_to_pick = { |
|
189
|
|
|
'just_semester': 'H' + semester_year_string, |
|
190
|
|
|
'just_quarter': 'Q' + quarter_string, |
|
191
|
|
|
'just_week': week_number_string, |
|
192
|
|
|
'semester': str(datetime.strftime(finalized_date, '%Y')) |
|
193
|
|
|
+ 'H' + semester_year_string, |
|
194
|
|
|
'semester_week': year_number_string + 'H' + semester_year_string |
|
195
|
|
|
+ 'wk' + week_number_string, |
|
196
|
|
|
'quarter': str(datetime.strftime(finalized_date, '%Y')) + 'Q' + quarter_string, |
|
197
|
|
|
'quarter_week': year_number_string + 'Q' + quarter_string |
|
198
|
|
|
+ 'wk' + week_number_string, |
|
199
|
|
|
'week': year_number_string + week_number_string, |
|
200
|
|
|
} |
|
201
|
|
|
final_string = values_to_pick.get(deviation_original) |
|
202
|
|
|
else: |
|
203
|
|
|
final_string = datetime.strftime( |
|
204
|
|
|
finalized_date, self.output_standard_formats.get(deviation_original)) |
|
205
|
|
|
return final_string |
|
206
|
|
|
|
|
207
|
|
|
def manage_parameter_value(self, in_logger, in_prefix, in_parameter, in_parameter_rules): |
|
208
|
|
|
element_to_join = '' |
|
209
|
|
|
if in_prefix == 'dict': |
|
210
|
|
|
element_to_join = in_parameter.values() |
|
211
|
|
|
elif in_prefix == 'list': |
|
212
|
|
|
element_to_join = in_parameter |
|
213
|
|
|
in_logger.debug(self.locale.gettext( |
|
214
|
|
|
'Current Parameter is {parameter_type} and has the value: "{str_value}"') |
|
215
|
|
|
.replace('{parameter_type}', self.locale.gettext(in_prefix.upper())) |
|
216
|
|
|
.replace('{str_value}', str(element_to_join))) |
|
217
|
|
|
return in_parameter_rules[in_prefix + '-values-prefix'] \ |
|
218
|
|
|
+ in_parameter_rules[in_prefix + '-values-glue'].join(element_to_join) \ |
|
219
|
|
|
+ in_parameter_rules[in_prefix + '-values-suffix'] |
|
220
|
|
|
|
|
221
|
|
|
@staticmethod |
|
222
|
|
|
def set_default_starting_weekday(in_dict): |
|
223
|
|
|
week_starts_with_iso_weekday = 1 |
|
224
|
|
|
if 'start-iso-weekday' in in_dict['session']: |
|
225
|
|
|
if in_dict['session']['start-iso-weekday'] == 'inherit-from-parent': |
|
226
|
|
|
in_dict['session']['start-iso-weekday'] = in_dict['query']['start-iso-weekday'] |
|
227
|
|
|
elif in_dict['session']['start-iso-weekday'] == 'inherit-from-grand-parent': |
|
228
|
|
|
in_dict['session']['start-iso-weekday'] = in_dict['sequence']['start-iso-weekday'] |
|
229
|
|
|
week_starts_with_iso_weekday = in_dict['session']['start-iso-weekday'] |
|
230
|
|
|
return week_starts_with_iso_weekday |
|
231
|
|
|
|
|
232
|
|
|
def simulate_final_query(self, local_logger, timer, in_query, in_parameters_number, in_tp): |
|
233
|
|
|
timer.start() |
|
234
|
|
|
return_query = in_query |
|
235
|
|
|
if in_parameters_number > 0: |
|
236
|
|
|
try: |
|
237
|
|
|
return_query = in_query % in_tp |
|
238
|
|
|
except TypeError as e: |
|
239
|
|
|
local_logger.error(self.locale.gettext( |
|
240
|
|
|
'Initial query expects {expected_parameters_counted} ' |
|
241
|
|
|
+ 'but only {given_parameters_counted} were provided') |
|
242
|
|
|
.replace('{expected_parameters_counted}', |
|
243
|
|
|
str(in_parameters_number)) |
|
244
|
|
|
.replace('{given_parameters_counted}', str(len(in_tp)))) |
|
245
|
|
|
local_logger.error(e) |
|
246
|
|
|
timer.stop() |
|
247
|
|
|
return return_query |
|
248
|
|
|
|
|
249
|
|
|
def stringify_parameters(self, local_logger, tuple_parameters, given_parameter_rules, |
|
250
|
|
|
in_start_iso_weekday): |
|
251
|
|
|
working_list = [] |
|
252
|
|
|
for ndx, crt_parameter in enumerate(tuple_parameters): |
|
253
|
|
|
current_parameter_type = type(crt_parameter) |
|
254
|
|
|
working_list.append(ndx) |
|
255
|
|
|
if current_parameter_type == str: |
|
256
|
|
|
local_logger.debug(self.locale.gettext( |
|
257
|
|
|
'Current Parameter is {parameter_type} and has the value: "{str_value}"') |
|
258
|
|
|
.replace('{parameter_type}', self.locale.gettext('STR')) |
|
259
|
|
|
.replace('{str_value}', crt_parameter)) |
|
260
|
|
|
working_list[ndx] = self.eval_expression( |
|
261
|
|
|
local_logger, crt_parameter, in_start_iso_weekday) |
|
262
|
|
|
elif current_parameter_type in (list, dict): |
|
263
|
|
|
prefix = str(current_parameter_type).replace("<class '", '').replace("'>", '') |
|
264
|
|
|
working_list[ndx] = self.manage_parameter_value( |
|
265
|
|
|
local_logger, prefix.lower(), crt_parameter, given_parameter_rules) |
|
266
|
|
|
final_tuple = tuple(working_list) |
|
267
|
|
|
local_logger.debug(self.locale.gettext('Final Tuple for Parameters is: {final_tuple}') |
|
268
|
|
|
.replace('{final_tuple}', str(final_tuple))) |
|
269
|
|
|
return final_tuple |
|
270
|
|
|
|
danielgp /
db-extractor
