Merge pull request #83 from alerta/tabular

satterly · web-flow · commit 0ef3cd06c026 · 2017-10-08T21:20:38.000+01:00
Rename serialize to tabular to avoid confusion
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-5.0.1
+5.0.2
diff --git a/alertaclient/commands/cmd_blackouts.py b/alertaclient/commands/cmd_blackouts.py
@@ -18,7 +18,7 @@ def cli(obj, purge):
         'duration': 'DURATION', 'status': 'STATUS', 'remaining': 'REMAINING', 'customer': 'CUSTOMER'
     }
     blackouts = client.get_blackouts()
-    click.echo(tabulate([b.serialize(timezone) for b in blackouts], headers=headers, tablefmt=obj['output']))
+    click.echo(tabulate([b.tabular(timezone) for b in blackouts], headers=headers, tablefmt=obj['output']))
 
     expired = [b for b in blackouts if b.status == 'expired']
     if purge:
diff --git a/alertaclient/commands/cmd_customers.py b/alertaclient/commands/cmd_customers.py
@@ -11,4 +11,4 @@ def cli(obj):
     """List customer lookups."""
     client = obj['client']
     headers = {'id': 'ID', 'customer': 'CUSTOMER', 'match': 'GROUP'}
-    click.echo(tabulate([c.serialize() for c in client.get_customers()], headers=headers, tablefmt=obj['output']))
+    click.echo(tabulate([c.tabular() for c in client.get_customers()], headers=headers, tablefmt=obj['output']))
diff --git a/alertaclient/commands/cmd_heartbeats.py b/alertaclient/commands/cmd_heartbeats.py
@@ -16,7 +16,7 @@ def cli(obj, purge):
         'receiveTime': 'RECEIVED', 'latency': 'LATENCY', 'timeout': 'TIMEOUT', 'since': 'SINCE', 'status': 'STATUS'
     }
     heartbeats = client.get_heartbeats()
-    click.echo(tabulate([h.serialize(timezone) for h in heartbeats], headers=headers, tablefmt=obj['output']))
+    click.echo(tabulate([h.tabular(timezone) for h in heartbeats], headers=headers, tablefmt=obj['output']))
 
     expired = [hb for hb in heartbeats if hb.status == 'expired']
     if purge:
diff --git a/alertaclient/commands/cmd_history.py b/alertaclient/commands/cmd_history.py
@@ -23,4 +23,4 @@ def cli(obj, ids, filters):
                'type': 'TYPE', 'customer': 'CUSTOMER', 'environment': 'ENVIRONMENT', 'service': 'SERVICE',
                'resource': 'RESOURCE', 'group': 'GROUP', 'event': 'EVENT', 'value': 'VALUE', 'text': 'TEXT'}
     click.echo(
-        tabulate([a.serialize(timezone) for a in alerts], headers=headers, tablefmt=obj['output']))
+        tabulate([a.tabular(timezone) for a in alerts], headers=headers, tablefmt=obj['output']))
diff --git a/alertaclient/commands/cmd_keys.py b/alertaclient/commands/cmd_keys.py
@@ -14,4 +14,4 @@ def cli(obj):
         'id': 'ID', 'key': 'API KEY', 'user': 'USER', 'scopes': 'SCOPES', 'text': 'TEXT',
         'expireTime': 'EXPIRES', 'count': 'COUNT', 'lastUsedTime': 'LAST USED', 'customer': 'CUSTOMER'
     }
-    click.echo(tabulate([k.serialize(timezone) for k in client.get_keys()], headers=headers, tablefmt=obj['output']))
+    click.echo(tabulate([k.tabular(timezone) for k in client.get_keys()], headers=headers, tablefmt=obj['output']))
diff --git a/alertaclient/commands/cmd_perms.py b/alertaclient/commands/cmd_perms.py
@@ -11,4 +11,4 @@ def cli(obj):
     """List permissions."""
     client = obj['client']
     headers = {'id': 'ID', 'scopes': 'SCOPES', 'match': 'ROLE'}
-    click.echo(tabulate([p.serialize() for p in client.get_perms()], headers=headers, tablefmt=obj['output']))
+    click.echo(tabulate([p.tabular() for p in client.get_perms()], headers=headers, tablefmt=obj['output']))
diff --git a/alertaclient/commands/cmd_query.py b/alertaclient/commands/cmd_query.py
@@ -34,7 +34,7 @@ def cli(obj, ids, filters, compact):
         headers = {'id': 'ID', 'lastReceiveTime': 'LAST RECEIVED', 'severity': 'SEVERITY', 'duplicateCount': 'DUPL',
                    'customer': 'CUSTOMER', 'environment': 'ENVIRONMENT', 'service': 'SERVICE', 'resource': 'RESOURCE',
                    'group': 'GROUP', 'event': 'EVENT', 'value': 'VALUE'}
-        click.echo(tabulate([a.serialize('summary', timezone) for a in alerts], headers=headers, tablefmt=obj['output']))
+        click.echo(tabulate([a.tabular('summary', timezone) for a in alerts], headers=headers, tablefmt=obj['output']))
     else:
         for alert in alerts:
             color = COLOR_MAP.get(alert.severity, {'fg': 'white'})
diff --git a/alertaclient/commands/cmd_users.py b/alertaclient/commands/cmd_users.py
@@ -13,4 +13,4 @@ def cli(obj):
     timezone = obj['timezone']
     headers = {'id': 'ID', 'name': 'USER', 'email': 'EMAIL', 'roles': 'ROLES', 'status': 'STATUS', 'text': 'TEXT',
                'createTime': 'CREATED', 'updateTime': 'LAST UPDATED', 'lastLogin': 'LAST LOGIN', 'email_verified': 'VERIFIED'}
-    click.echo(tabulate([u.serialize(timezone) for u in client.get_users()], headers=headers, tablefmt=obj['output']))
+    click.echo(tabulate([u.tabular(timezone) for u in client.get_users()], headers=headers, tablefmt=obj['output']))
diff --git a/alertaclient/models/alert.py b/alertaclient/models/alert.py
@@ -46,6 +46,10 @@ def __init__(self, resource, event, **kwargs):
         self.last_receive_time = kwargs.get('last_receive_time', None)
         self.history = kwargs.get('history', None) or list()
 
+    def __repr__(self):
+        return 'Alert(id=%r, environment=%r, resource=%r, event=%r, severity=%r, status=%r, customer=%r)' % (
+            self.id, self.environment, self.resource, self.event, self.severity, self.status, self.customer)
+
     @classmethod
     def parse(cls, json):
         if not isinstance(json.get('correlate', []), list):
@@ -91,7 +95,7 @@ def parse(cls, json):
     def get_id(self, short=False):
         return self.id[:8] if short else self.id
 
-    def serialize(self, fields='all', timezone='Europe/London'):
+    def tabular(self, fields='all', timezone='Europe/London'):
         if fields == 'summary':
             return {
                 'id': self.get_id(short=True),
@@ -147,7 +151,3 @@ def serialize(self, fields='all', timezone='Europe/London'):
                 'lastReceiveTime': DateTime.localtime(self.last_receive_time, timezone),
                 'history': [h.serialize(timezone) for h in self.history]
             }
-
-    def __repr__(self):
-        return 'Alert(id=%r, environment=%r, resource=%r, event=%r, severity=%r, status=%r, customer=%r)' % (
-            self.id, self.environment, self.resource, self.event, self.severity, self.status, self.customer)
diff --git a/alertaclient/models/blackout.py b/alertaclient/models/blackout.py
@@ -56,6 +56,32 @@ def __init__(self, environment, **kwargs):
             self.status = "expired"
             self.remaining = 0
 
+    def __repr__(self):
+        more = ''
+        if self.service:
+            more += 'service=%r, ' % self.service
+        if self.resource:
+            more += 'resource=%r, ' % self.resource
+        if self.event:
+            more += 'event=%r, ' % self.event
+        if self.group:
+            more += 'group=%r, ' % self.group
+        if self.tags:
+            more += 'tags=%r, ' % self.tags
+        if self.customer:
+            more += 'customer=%r, ' % self.customer
+
+        return 'Blackout(id=%r, priority=%r, status=%r, environment=%r, %sstart_time=%r, end_time=%r, remaining=%r)' % (
+            self.id,
+            self.priority,
+            self.status,
+            self.environment,
+            more,
+            self.start_time,
+            self.end_time,
+            self.remaining
+        )
+
     @classmethod
     def parse(cls, json):
         if not isinstance(json.get('service', []), list):
@@ -77,7 +103,7 @@ def parse(cls, json):
             duration=json.get('duration', None)
         )
 
-    def serialize(self, timezone='Europe/London'):
+    def tabular(self, timezone='Europe/London'):
         return {
             'id': self.id,
             'priority': self.priority,
@@ -94,29 +120,3 @@ def serialize(self, timezone='Europe/London'):
             'status': self.status,
             'remaining': '{}s'.format(self.remaining)
         }
-
-    def __repr__(self):
-        more = ''
-        if self.service:
-            more += 'service=%r, ' % self.service
-        if self.resource:
-            more += 'resource=%r, ' % self.resource
-        if self.event:
-            more += 'event=%r, ' % self.event
-        if self.group:
-            more += 'group=%r, ' % self.group
-        if self.tags:
-            more += 'tags=%r, ' % self.tags
-        if self.customer:
-            more += 'customer=%r, ' % self.customer
-
-        return 'Blackout(id=%r, priority=%r, status=%r, environment=%r, %sstart_time=%r, end_time=%r, remaining=%r)' % (
-            self.id,
-            self.priority,
-            self.status,
-            self.environment,
-            more,
-            self.start_time,
-            self.end_time,
-            self.remaining
-        )
diff --git a/alertaclient/models/customer.py b/alertaclient/models/customer.py
@@ -6,6 +6,10 @@ def __init__(self, match, customer, **kwargs):
         self.match = match
         self.customer = customer
 
+    def __repr__(self):
+        return 'Customer(id=%r, match=%r, customer=%r)' % (
+            self.id, self.match, self.customer)
+
     @classmethod
     def parse(cls, json):
         return Customer(
@@ -14,13 +18,9 @@ def parse(cls, json):
             customer=json.get('customer', None)
         )
 
-    def serialize(self):
+    def tabular(self):
         return {
             'id': self.id,
             'match': self.match,
             'customer': self.customer
         }
-
-    def __repr__(self):
-        return 'Customer(id=%r, match=%r, customer=%r)' % (
-            self.id, self.match, self.customer)
diff --git a/alertaclient/models/heartbeat.py b/alertaclient/models/heartbeat.py
@@ -36,6 +36,10 @@ def status(self):
         else:
             return 'ok'
 
+    def __repr__(self):
+        return 'Heartbeat(id=%r, origin=%r, create_time=%r, timeout=%r, customer=%r)' % (
+            self.id, self.origin, self.create_time, self.timeout, self.customer)
+
     @classmethod
     def parse(cls, json):
         if not isinstance(json.get('tags', []), list):
@@ -54,7 +58,7 @@ def parse(cls, json):
             customer=json.get('customer', None)
         )
 
-    def serialize(self, timezone='Europe/London'):
+    def tabular(self, timezone='Europe/London'):
         return {
             'id': self.id,
             'origin': self.origin,
@@ -67,7 +71,3 @@ def serialize(self, timezone='Europe/London'):
             'since': self.since,
             'status': self.status
         }
-
-    def __repr__(self):
-        return 'Heartbeat(id=%r, origin=%r, create_time=%r, timeout=%r, customer=%r)' % (
-            self.id, self.origin, self.create_time, self.timeout, self.customer)
diff --git a/alertaclient/models/history.py b/alertaclient/models/history.py
@@ -42,6 +42,10 @@ def __init__(self, resource, event, **kwargs):
         self.event_type = kwargs.get('event_type', kwargs.get('type', None))
         self.customer = kwargs.get('customer', None)
 
+    def __repr__(self):
+        return 'RichHistory(id=%r, environment=%r, resource=%r, event=%r, severity=%r, status=%r, customer=%r)' % (
+            self.id, self.environment, self.resource, self.event, self.severity, self.status, self.customer)
+
     @classmethod
     def parse(cls, json):
         if not isinstance(json.get('service', []), list):
@@ -68,7 +72,7 @@ def parse(cls, json):
             customer=json.get('customer', None)
         )
 
-    def serialize(self, timezone='Europe/London'):
+    def tabular(self, timezone='Europe/London'):
         data = {
             'id': self.id,
             'resource': self.resource,
@@ -93,7 +97,3 @@ def serialize(self, timezone='Europe/London'):
             data['status'] = self.status
 
         return data
-
-    def __repr__(self):
-        return 'RichHistory(id=%r, environment=%r, resource=%r, event=%r, severity=%r, status=%r, customer=%r)' % (
-            self.id, self.environment, self.resource, self.event, self.severity, self.status, self.customer)
diff --git a/alertaclient/models/key.py b/alertaclient/models/key.py
@@ -19,6 +19,10 @@ def __init__(self, user, scopes, text='', expire_time=None, customer=None, **kwa
     def type(self):
         return self.scopes_to_type(self.scopes)
 
+    def __repr__(self):
+        return 'ApiKey(key=%r, user=%r, scopes=%r, expireTime=%r, customer=%r)' % (
+            self.key, self.user, self.scopes, self.expire_time, self.customer)
+
     @classmethod
     def parse(cls, json):
         if not isinstance(json.get('scopes', []), list):
@@ -42,7 +46,7 @@ def scopes_to_type(self, scopes):
                 return 'read-write'
         return 'read-only'
 
-    def serialize(self, timezone='Europe/London'):
+    def tabular(self, timezone='Europe/London'):
         return {
             'id': self.id,
             'key': self.key,
@@ -54,7 +58,3 @@ def serialize(self, timezone='Europe/London'):
             'lastUsedTime': DateTime.localtime(self.last_used_time, timezone),
             'customer': self.customer
         }
-
-    def __repr__(self):
-        return 'ApiKey(key=%r, user=%r, scopes=%r, expireTime=%r, customer=%r)' % (
-            self.key, self.user, self.scopes, self.expire_time, self.customer)
diff --git a/alertaclient/models/permission.py b/alertaclient/models/permission.py
@@ -7,6 +7,10 @@ def __init__(self, match, scopes, **kwargs):
         self.match = match
         self.scopes = scopes or list()
 
+    def __repr__(self):
+        return 'Perm(id=%r, match=%r, scopes=%r)' % (
+            self.id, self.match, self.scopes)
+
     @classmethod
     def parse(cls, json):
         if not isinstance(json.get('scopes', []), list):
@@ -18,13 +22,9 @@ def parse(cls, json):
             scopes=json.get('scopes', list())
         )
 
-    def serialize(self):
+    def tabular(self):
         return {
             'id': self.id,
             'match': self.match,
             'scopes': ','.join(self.scopes)
         }
-
-    def __repr__(self):
-        return 'Perm(id=%r, match=%r, scopes=%r)' % (
-            self.id, self.match, self.scopes)
diff --git a/alertaclient/models/user.py b/alertaclient/models/user.py
@@ -26,6 +26,11 @@ def __init__(self, name, email, roles, text, **kwargs):
     def domain(self):
         return self.email.split('@')[1] if '@' in self.email else None
 
+    def __repr__(self):
+        return 'User(id=%r, name=%r, email=%r, status=%r, roles=%r, email_verified=%r)' % (
+            self.id, self.name, self.email, self.status, ','.join(self.roles), self.email_verified
+        )
+
     @classmethod
     def parse(cls, json):
         return User(
@@ -42,7 +47,7 @@ def parse(cls, json):
             email_verified=json.get('email_verified', None)
         )
 
-    def serialize(self, timezone='Europe/London'):
+    def tabular(self, timezone='Europe/London'):
         return {
             'id': self.id,
             'name': self.name,
@@ -56,8 +61,3 @@ def serialize(self, timezone='Europe/London'):
             'updateTime': DateTime.localtime(self.update_time, timezone),
             'email_verified': 'yes' if self.email_verified else 'no'
         }
-
-    def __repr__(self):
-        return 'User(id=%r, name=%r, email=%r, status=%r, roles=%r, email_verified=%r)' % (
-            self.id, self.name, self.email, self.status, ','.join(self.roles), self.email_verified
-        )
diff --git a/alertaclient/version.py b/alertaclient/version.py
@@ -1 +1 @@
-__version__ = '5.0.1'
+__version__ = '5.0.2'

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ def cli(obj, purge):`
`18`	`18`	`'duration': 'DURATION', 'status': 'STATUS', 'remaining': 'REMAINING', 'customer': 'CUSTOMER'`
`19`	`19`	`}`
`20`	`20`	`blackouts = client.get_blackouts()`
`21`		`- click.echo(tabulate([b.serialize(timezone) for b in blackouts], headers=headers, tablefmt=obj['output']))`
	`21`	`+ click.echo(tabulate([b.tabular(timezone) for b in blackouts], headers=headers, tablefmt=obj['output']))`
`22`	`22`
`23`	`23`	`expired = [b for b in blackouts if b.status == 'expired']`
`24`	`24`	`if purge:`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ def cli(obj, purge):`
`16`	`16`	`'receiveTime': 'RECEIVED', 'latency': 'LATENCY', 'timeout': 'TIMEOUT', 'since': 'SINCE', 'status': 'STATUS'`
`17`	`17`	`}`
`18`	`18`	`heartbeats = client.get_heartbeats()`
`19`		`- click.echo(tabulate([h.serialize(timezone) for h in heartbeats], headers=headers, tablefmt=obj['output']))`
	`19`	`+ click.echo(tabulate([h.tabular(timezone) for h in heartbeats], headers=headers, tablefmt=obj['output']))`
`20`	`20`
`21`	`21`	`expired = [hb for hb in heartbeats if hb.status == 'expired']`
`22`	`22`	`if purge:`
Original file line number	Diff line number	Diff line change
`@@ -14,4 +14,4 @@ def cli(obj):`
`14`	`14`	`'id': 'ID', 'key': 'API KEY', 'user': 'USER', 'scopes': 'SCOPES', 'text': 'TEXT',`
`15`	`15`	`'expireTime': 'EXPIRES', 'count': 'COUNT', 'lastUsedTime': 'LAST USED', 'customer': 'CUSTOMER'`
`16`	`16`	`}`
`17`		`- click.echo(tabulate([k.serialize(timezone) for k in client.get_keys()], headers=headers, tablefmt=obj['output']))`
	`17`	`+ click.echo(tabulate([k.tabular(timezone) for k in client.get_keys()], headers=headers, tablefmt=obj['output']))`