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
|
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
class EntityFormatter(object):
"""Base Mixin class providing functions that format entities for display.
Must be used in conjunction with a Formatter mixin that provides
the function _get_formatted_data().
"""
def _get_sorted_list(self, obj_list):
return obj_list
def list_objects(self, obj_list):
columns = []
data = (self._get_generic_data(obj) for obj in
self._get_sorted_list(obj_list))
if obj_list:
columns = self._get_generic_columns()
return columns, data
def _get_generic_data(self, obj):
return self._get_formatted_data(obj)
def _get_generic_columns(self):
return self.columns
def get_formatted_entity(self, obj):
return self.columns, self._get_formatted_data(obj)
def _get_percent_string(
self, current_value, max_value, percent_format="{:.0f}%"):
if current_value in [None, 0] or max_value in [None, 0]:
# considered a one-step job by convention:
return None
return percent_format.format((current_value * 100) / max_value)
def _format_progress_update(self, progress_update):
event_format = "%(created_at)s %(message)s"
percent_string = self._get_percent_string(
progress_update.get("current_step"),
progress_update.get("total_steps"))
format_data = {
"created_at": progress_update.get("created_at"),
"percent": percent_string,
"message": progress_update.get("message")}
if percent_string:
event_format = "%(created_at)s [%(percent)s] %(message)s"
format_data["percent"] = percent_string
return event_format % format_data
|
