1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
# Copyright 2013 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
import numbers
from telemetry import value as value_module
from telemetry.value import list_of_scalar_values
from telemetry.value import none_values
from telemetry.value import summarizable
class ScalarValue(summarizable.SummarizableValue):
def __init__(self, page, name, units, value, important=True,
description=None, tir_label=None,
none_value_reason=None, improvement_direction=None,
grouping_keys=None):
"""A single value (float or integer) result from a test.
A test that counts the number of DOM elements in a page might produce a
scalar value:
ScalarValue(page, 'num_dom_elements', 'count', num_elements)
"""
super(ScalarValue, self).__init__(page, name, units, important, description,
tir_label, improvement_direction,
grouping_keys)
assert value is None or isinstance(value, numbers.Number)
none_values.ValidateNoneValueReason(value, none_value_reason)
self.value = value
self.none_value_reason = none_value_reason
def __repr__(self):
if self.page:
page_name = self.page.display_name
else:
page_name = 'None'
return ('ScalarValue(%s, %s, %s, %s, important=%s, description=%s, '
'tir_label=%s, improvement_direction=%s, grouping_keys=%s') % (
page_name,
self.name,
self.units,
self.value,
self.important,
self.description,
self.tir_label,
self.improvement_direction,
self.grouping_keys)
def GetBuildbotDataType(self, output_context):
if self._IsImportantGivenOutputIntent(output_context):
return 'default'
return 'unimportant'
def GetBuildbotValue(self):
# Buildbot's print_perf_results method likes to get lists for all values,
# even when they are scalar, so list-ize the return value.
return [self.value]
def GetRepresentativeNumber(self):
return self.value
def GetRepresentativeString(self):
return str(self.value)
@staticmethod
def GetJSONTypeName():
return 'scalar'
def AsDict(self):
d = super(ScalarValue, self).AsDict()
d['value'] = self.value
if self.none_value_reason is not None:
d['none_value_reason'] = self.none_value_reason
return d
@staticmethod
def FromDict(value_dict, page_dict):
kwargs = value_module.Value.GetConstructorKwArgs(value_dict, page_dict)
# Infinity and NaN are left out of JSON for security reasons that do not
# apply to our use cases, so TBMv2 serializes them as strings,
# but TBMv1 doesn't support them.
if value_dict['value'] in ['Infinity', '-Infinity', 'NaN']:
kwargs['value'] = None
kwargs['none_value_reason'] = 'value was ' + value_dict['value']
else:
kwargs['value'] = value_dict['value']
if 'improvement_direction' in value_dict:
kwargs['improvement_direction'] = value_dict['improvement_direction']
if 'none_value_reason' in value_dict:
kwargs['none_value_reason'] = value_dict['none_value_reason']
return ScalarValue(**kwargs)
@classmethod
def MergeLikeValuesFromSamePage(cls, values):
assert len(values) > 0
v0 = values[0]
return cls._MergeLikeValues(values, v0.page, v0.name, v0.grouping_keys)
@classmethod
def MergeLikeValuesFromDifferentPages(cls, values):
assert len(values) > 0
v0 = values[0]
return cls._MergeLikeValues(values, None, v0.name, v0.grouping_keys)
@classmethod
def _MergeLikeValues(cls, values, page, name, grouping_keys):
v0 = values[0]
merged_value = [v.value for v in values]
none_value_reason = None
if None in merged_value:
merged_value = None
merged_none_values = [v for v in values if v.value is None]
none_value_reason = (
none_values.MERGE_FAILURE_REASON +
' None values: %s' % repr(merged_none_values))
return list_of_scalar_values.ListOfScalarValues(
page, name, v0.units, merged_value, important=v0.important,
description=v0.description,
tir_label=value_module.MergedTirLabel(values),
none_value_reason=none_value_reason,
improvement_direction=v0.improvement_direction,
grouping_keys=grouping_keys)
|
