Add __repr__ methods for Buffer, Tabpage and Window

Author: blueyed

neovim/api/buffer.py

@@ -26,6 +26,14 @@ class Buffer(Remote):
 
     _api_prefix = "nvim_buf_"
 
+    def __repr__(self):
+        """Get text representation of the buffer."""
+        return 'Buffer(number=%r, name=%r, filetype=%r)' % (
+            self.number,
+            self.name,
+            self.options.get('filetype'),
+        )
+
     def __len__(self):
         """Return the number of lines contained in a Buffer."""
         return self.request('nvim_buf_line_count')

neovim/api/tabpage.py

@@ -19,6 +19,13 @@ def __init__(self, *args):
         super(Tabpage, self).__init__(*args)
         self.windows = RemoteSequence(self, 'nvim_tabpage_list_wins')
 
+    def __repr__(self):
+        """Get text representation of the tabpage."""
+        return 'Tabpage(number=%r, window=%r)' % (
+            self.number,
+            self.window,
+        )
+
     @property
     def window(self):
         """Get the `Window` currently focused on the tabpage."""

neovim/api/window.py

@@ -11,6 +11,13 @@ class Window(Remote):
 
     _api_prefix = "nvim_win_"
 
+    def __repr__(self):
+        """Get text representation of the window."""
+        return 'Window(number=%r, buffer=%r)' % (
+            self.number,
+            self.buffer,
+        )
+
     @property
     def buffer(self):
         """Get the `Buffer` currently being displayed by the window."""

test/test_buffer.py

@@ -3,6 +3,13 @@
 from neovim.compat import IS_PYTHON3
 
 
+def test_repr(vim):
+    assert repr(vim.current.buffer) == "Buffer(number=2, name='')"
+    vim.command('file name with spaces')
+    fname = os.path.join(os.getcwd(), 'name with spaces')
+    assert repr(vim.current.buffer) == "Buffer(number=2, name='%s')" % fname
+
+
 def test_get_length(vim):
     assert len(vim.current.buffer) == 1
     vim.current.buffer.append('line')