feat: add __repr__ methods for FluxTable, FluxColumn, FluxRecord (influxdata#281)

takluyver · web-flow · commit 2a0bd826cb3b · 2021-07-09T11:03:33.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 ## 1.20.0 [unreleased]
 
+### Features
+1. [#281](https://github.com/influxdata/influxdb-client-python/pull/281): `FluxTable`, `FluxColumn` and `FluxRecord` objects have helpful reprs
+
 ## 1.19.0 [2021-07-09]
 
 ### Features
diff --git a/influxdb_client/client/flux_table.py b/influxdb_client/client/flux_table.py
@@ -32,6 +32,10 @@ def __str__(self):
         cls_name = type(self).__name__
         return cls_name + "() columns: " + str(len(self.columns)) + ", records: " + str(len(self.records))
 
+    def __repr__(self):
+        """Format for inspection."""
+        return f"<{type(self).__name__}: {len(self.columns)} columns, {len(self.records)} records>"
+
     def __iter__(self):
         """Iterate over records."""
         return iter(self.records)
@@ -48,6 +52,15 @@ def __init__(self, index=None, label=None, data_type=None, group=None, default_v
         self.label = label
         self.index = index
 
+    def __repr__(self):
+        """Format for inspection."""
+        fields = [repr(self.index)] + [
+            f'{name}={getattr(self, name)!r}' for name in (
+                'label', 'data_type', 'group', 'default_value'
+            ) if getattr(self, name) is not None
+        ]
+        return f"{type(self).__name__}({', '.join(fields)})"
+
 
 class FluxRecord(FluxStructure):
     """A record is a tuple of named values and is represented using an object type."""
@@ -95,3 +108,7 @@ def __str__(self):
         """Return formatted output."""
         cls_name = type(self).__name__
         return cls_name + "() table: " + str(self.table) + ", " + str(self.values)
+
+    def __repr__(self):
+        """Format for inspection."""
+        return f"<{type(self).__name__}: field={self.values.get('_field')}, value={self.values.get('_value')}>"
