Merge pull request #128 from xray/data-array-repr

Expose more information in DataArray.__repr__

Author: shoyer

test/test_data_array.py

@@ -20,11 +20,17 @@ def setUp(self):
 
     def test_repr(self):
         v = Variable(['time', 'x'], [[1, 2, 3], [4, 5, 6]], {'foo': 'bar'})
-        data_array = Dataset({'my_variable': v})['my_variable']
+        data_array = Dataset({'my_variable': v, 'other': ([], 0)}
+                             )['my_variable']
         expected = dedent("""
         <xray.DataArray 'my_variable' (time: 2, x: 3)>
         array([[1, 2, 3],
                [4, 5, 6]])
+        Coordinates:
+            time: Int64Index([0, 1], dtype='int64')
+            x: Int64Index([0, 1, 2], dtype='int64')
+        Linked dataset variables:
+            other
         Attributes:
             foo: bar
         """).strip()

xray/common.py

@@ -123,6 +123,13 @@ def _summarize_attributes(data):
     return attr_summary
 
 
+def _wrap_indent(text, start='', length=None):
+    if length is None:
+        length = len(start)
+    indent = '\n' + ' ' * length
+    return start + indent.join(x for x in text.splitlines())
+
+
 def array_repr(arr):
     name_str = ('%r ' % arr.name) if hasattr(arr, 'name') else ''
     dim_summary = ', '.join('%s: %s' % (k, v) for k, v
@@ -132,6 +139,16 @@ def array_repr(arr):
         summary.append(repr(arr.values))
     else:
         summary.append('[%s values with dtype=%s]' % (arr.size, arr.dtype))
+    if hasattr(arr, 'name'):
+        if arr.coordinates:
+            summary.append('Coordinates:')
+            for k, v in arr.coordinates.items():
+                summary.append(_wrap_indent(repr(v.as_index), '    %s: ' % k))
+        other_vars = [k for k in arr.dataset
+                      if k not in arr.coordinates and k != arr.name]
+        if other_vars:
+            summary.append('Linked dataset variables:')
+            summary.append('    ' + ', '.join(other_vars))
     summary.append('Attributes:\n%s' % _summarize_attributes(arr))
     return '\n'.join(summary)