def new_function(*args, **kwargs):
"""
Wrapped function
"""
start = time.time()
result = f(*args, **kwargs)
if result is None:
return OVSResponse(status=status.HTTP_204_NO_CONTENT,
timings={'load': [time.time() - start, 'Load data']})
return OVSResponse(result,
status=return_status,
timings={'load': [time.time() - start, 'Load data']})
def new_function(*args, **kwargs):
"""
Wrapped function
"""
request = _find_request(args)
timings = {}
contents = request.QUERY_PARAMS.get('contents')
contents = None if contents is None else contents.split(',')
start = time.time()
obj = f(*args, **kwargs)
timings['fetch'] = [time.time() - start, 'Fetching data']
obj.reset_timings()
start = time.time()
data = FullSerializer(object_type, contents=contents,
instance=obj).data
timings['serializing'] = [time.time() - start, 'Serializing']
dynamic_timings = obj.get_timings()
for timing in dynamic_timings:
timings['dynamic_{0}'.format(timing)] = [
dynamic_timings[timing], 'Load \'{0}\''.format(timing)
]
return OVSResponse(data, status=return_status, timings=timings)
def process_request(self, request):
"""
Processes requests
"""
_ = self
start = time.time()
# Processes CORS preflight requests
if request.method == 'OPTIONS' and 'HTTP_ACCESS_CONTROL_REQUEST_METHOD' in request.META:
return HttpResponse()
# Validate version
path = request.path
regex = re.compile('^(.*; )?version=(?P<version>([0-9]+|\*)?)(;.*)?$')
if path != '/api/' and '/api/oauth2/' not in path and '/swagger.json' not in path:
if 'HTTP_ACCEPT' not in request.META or regex.match(
request.META['HTTP_ACCEPT']) is None:
return OVSResponse(json.dumps({
'error':
'missing_header',
'error_description':
"The version required by the client should be added to the Accept header. E.g.: 'Accept: application/json; version=1'"
}),
status=406,
content_type='application/json',
timings={
'total': [time.time() - start, 'Total']
})
request._entry_time = time.time()
return None
def new_function(*args, **kwargs):
"""
Wrapped function
"""
start = time.time()
task = f(*args, **kwargs)
return OVSResponse(task.id,
status=status.HTTP_200_OK,
timings={'launch': [time.time() - start, 'Launch task']})
def new_function(*args, **kwargs):
"""
Wrapped function
"""
request = _find_request(args)
timings = {}
# 1. Pre-loading request data
start = time.time()
sort = request.QUERY_PARAMS.get('sort')
if sort is None and default_sort is not None:
sort = default_sort
sort = None if sort is None else [
s for s in reversed(sort.split(','))
]
page = request.QUERY_PARAMS.get('page')
page = int(page) if page is not None and page.isdigit() else None
page_size = request.QUERY_PARAMS.get('page_size')
page_size = int(
page_size
) if page_size is not None and page_size.isdigit() else None
page_size = page_size if page_size in [10, 25, 50, 100] else 10
contents = request.QUERY_PARAMS.get('contents')
contents = None if contents is None else contents.split(',')
timings['preload'] = [time.time() - start, 'Data preloading']
# 2. Construct hints for decorated function (so it can provide full objects if required)
start = time.time()
if 'hints' not in kwargs:
kwargs['hints'] = {}
kwargs['hints']['full'] = sort is not None or contents is not None
timings['hinting'] = [time.time() - start, 'Request hinting']
# 3. Fetch data
start = time.time()
data_list = f(*args, **kwargs)
guid_list = isinstance(data_list,
list) and len(data_list) > 0 and isinstance(
data_list[0], basestring)
timings['fetch'] = [time.time() - start, 'Fetching data']
# 4. Sorting
if sort is not None:
start = time.time()
if guid_list is True:
data_list = [object_type(guid) for guid in data_list]
guid_list = False # The list is converted to objects
for sort_item in sort:
desc = sort_item[0] == '-'
field = sort_item[1 if desc else 0:]
data_list.sort(
key=lambda e: DalToolbox.extract_key(e, field),
reverse=desc)
timings['sort'] = [time.time() - start, 'Sorting data']
# 5. Paging
start = time.time()
total_items = len(data_list)
page_metadata = {
'total_items': total_items,
'current_page': 1,
'max_page': 1,
'page_size': page_size,
'start_number': min(1, total_items),
'end_number': total_items
}
if page is not None:
max_page = int(math.ceil(total_items / (page_size * 1.0)))
if page > max_page:
page = max_page
if page == 0:
start_number = -1
end_number = 0
else:
start_number = (
page - 1
) * page_size # Index - e.g. 0 for page 1, 10 for page 2
end_number = start_number + page_size # Index - e.g. 10 for page 1, 20 for page 2
data_list = data_list[start_number:end_number]
page_metadata.update({
'current_page': max(1, page),
'max_page': max(1, max_page),
'start_number': start_number + 1,
'end_number': min(total_items, end_number)
})
else:
page_metadata['page_size'] = total_items
timings['paging'] = [time.time() - start, 'Selecting current page']
# 6. Serializing
start = time.time()
if contents is not None:
if guid_list is True:
data_list = [object_type(guid) for guid in data_list]
data = FullSerializer(object_type,
contents=contents,
instance=data_list,
many=True).data
else:
if guid_list is False:
data_list = [item.guid for item in data_list]
data = data_list
timings['serializing'] = [time.time() - start, 'Serializing']
if contents is not None and len(data_list) > 0:
object_timings = {}
for obj in data_list:
dynamic_timings = obj.get_timings()
for timing in dynamic_timings:
key = 'dynamic_{0}'.format(timing)
if key not in object_timings:
object_timings[key] = []
object_timings[key].append([
dynamic_timings[timing],
'Load \'{0}\''.format(timing)
])
for key in object_timings:
times = [entry[0] for entry in object_timings[key]]
timings[key] = [sum(times), object_timings[key][0][1]]
timings['{0}_avg'.format(key)] = [
sum(times) / len(times),
'{0} (avg)'.format(object_timings[key][0][1])
]
timings['{0}_min'.format(key)] = [
min(times),
'{0} (min)'.format(object_timings[key][0][1])
]
timings['{0}_max'.format(key)] = [
max(times),
'{0} (max)'.format(object_timings[key][0][1])
]
result = {
'data': data,
'_paging': page_metadata,
'_contents': contents,
'_sorting': [s for s in reversed(sort)] if sort else sort
}
# 7. Building response
return OVSResponse(result,
status=status.HTTP_200_OK,
timings=timings)
def new_function(*args, **kwargs):
"""
Wrapped function
This function will process the api request an apply:
- Paging (only return a subset of all results)
- Sorting (sort on properties)
- Filtering (filter on properties)
Request arguments for paging:
- page: The page number for which the items should be displayed (string/int)
- page_size: The size of the pages (string/int)
Request arguments for sorting:
- sort: Comma separated list of the properties to sort on. Prefix with '-' to use descending order (eg name,-description) (string)
Request arguments for filtering: identical to DataList query params
- query: The query to perform. See DataList execute_query method for more info
"""
request = _find_request(args)
timings = {}
# 1. Pre-loading request data
start = time.time()
sort = request.QUERY_PARAMS.get('sort')
query = request.QUERY_PARAMS.get('query')
if query is not None:
try:
query = json.loads(query)
DataList.validate_query(query)
except ValueError as ex:
raise ValueError('Query is not valid: \'{0}\''.format(
str(ex)))
if sort is None and default_sort is not None:
sort = default_sort
sort = None if sort is None else [
s for s in reversed(sort.split(','))
]
page = request.QUERY_PARAMS.get('page')
page = int(page) if page is not None and (
isinstance(page, int) or page.isdigit()) else None
page_size = request.QUERY_PARAMS.get('page_size')
page_size = int(page_size) if page_size is not None and (
isinstance(page_size, int) or page_size.isdigit()) else None
contents = request.QUERY_PARAMS.get('contents')
contents = None if contents is None else contents.split(',')
timings['preload'] = [time.time() - start, 'Data preloading']
# 2. Construct hints for decorated function (so it can provide full objects if required)
start = time.time()
if 'hints' not in kwargs:
kwargs['hints'] = {}
kwargs['hints']['full'] = sort is not None or contents is not None
timings['hinting'] = [time.time() - start, 'Request hinting']
# 3. Fetch data
start = time.time()
data_list = f(*args, **kwargs)
guid_list = isinstance(data_list,
list) and len(data_list) > 0 and isinstance(
data_list[0], basestring)
timings['fetch'] = [time.time() - start, 'Fetching data']
# 4. Filtering data
if query is not None:
start = time.time()
if guid_list is True:
guids = data_list
guid_list = False # The list will be converted to a datalist
else:
guids = data_list.guids
# Use the guids from the result list as a base to query inside the functions results and apply the query
data_list = DataList(object_type, query=query, guids=guids)
# Trigger the query
_ = data_list.guids
timings['querying'] = [time.time() - start, 'Querying data']
# 5. Sorting
if sort is not None:
start = time.time()
if guid_list is True:
data_list = DataList(object_type, guids=data_list)
guid_list = False # The list is converted to objects
for sort_item in sort:
desc = sort_item[0] == '-'
field = sort_item[1 if desc else 0:]
data_list.sort(
key=lambda e: DalToolbox.extract_key(e, field),
reverse=desc)
timings['sort'] = [time.time() - start, 'Sorting data']
# 6. Paging
start = time.time()
total_items = len(data_list)
page_metadata = {
'total_items': total_items,
'current_page': 1,
'max_page': 1,
'page_size': page_size,
'start_number': min(1, total_items),
'end_number': total_items
}
if page is not None:
max_page = int(math.ceil(total_items / (page_size * 1.0)))
if page > max_page:
page = max_page
if page == 0:
start_number = -1
end_number = 0
else:
start_number = (
page - 1
) * page_size # Index - e.g. 0 for page 1, 10 for page 2
end_number = start_number + page_size # Index - e.g. 10 for page 1, 20 for page 2
data_list = data_list[start_number:end_number]
page_metadata.update({
'current_page': max(1, page),
'max_page': max(1, max_page),
'start_number': start_number + 1,
'end_number': min(total_items, end_number)
})
else:
page_metadata['page_size'] = total_items
timings['paging'] = [time.time() - start, 'Selecting current page']
# 7. Serializing
start = time.time()
if contents is not None:
if guid_list is True:
data_list = DataList(object_type, guids=data_list)
data = FullSerializer(object_type,
contents=contents,
instance=data_list,
many=True).data
else:
if guid_list is False:
data_list = data_list.guids # 'data_list' is a ovs.dal.datalist.DataList which has the guids stored
data = data_list
timings['serializing'] = [time.time() - start, 'Serializing']
# Add timings about dynamics
if contents is not None and len(data_list) > 0:
object_timings = {}
for obj in data_list:
dynamic_timings = obj.get_timings()
for timing in dynamic_timings:
key = 'dynamic_{0}'.format(timing)
if key not in object_timings:
object_timings[key] = []
object_timings[key].append([
dynamic_timings[timing],
'Load \'{0}\''.format(timing)
])
for key in object_timings:
times = [entry[0] for entry in object_timings[key]]
timings[key] = [sum(times), object_timings[key][0][1]]
timings['{0}_avg'.format(key)] = [
sum(times) / len(times),
'{0} (avg)'.format(object_timings[key][0][1])
]
timings['{0}_min'.format(key)] = [
min(times),
'{0} (min)'.format(object_timings[key][0][1])
]
timings['{0}_max'.format(key)] = [
max(times),
'{0} (max)'.format(object_timings[key][0][1])
]
result = {
'data': data,
'_paging': page_metadata,
'_contents': contents,
'_sorting': [s for s in reversed(sort)] if sort else sort
}
# 8. Building response
return OVSResponse(result,
status=status.HTTP_200_OK,
timings=timings)