Merge pull request #44 from zilder/node_repr

Add PostgresNode.__repr__() method

Author: funbringer

testgres/api.py

@@ -12,9 +12,9 @@
 ...     result = node.safe_psql('postgres', 'select 1')
 ...     print(result.decode('utf-8').strip())
 ...     node.stop()
-<testgres.node.PostgresNode object at 0x...>
+PostgresNode(name='...', port=..., base_dir='...')
 1
-<testgres.node.PostgresNode object at 0x...>
+PostgresNode(name='...', port=..., base_dir='...')
 
     Or:
 
@@ -27,7 +27,7 @@
 ...             master.execute('postgres', 'insert into test values (0), (1), (2)')
 ...             replica.catchup()  # wait until changes are visible
 ...             print(replica.execute('postgres', 'select count(*) from test'))
-<testgres.node.PostgresNode object at 0x...>
+PostgresNode(name='...', port=..., base_dir='...')
 [(3,)]
 
 Copyright (c) 2016, Postgres Professional

testgres/config.py

@@ -152,9 +152,11 @@ def scoped_config(**options):
     Temporarily set custom GlobalConfig options for this context.
 
     Example:
+        >>> from .api import get_new_node
         >>> with scoped_config(cache_initdb=False):
         ...     with get_new_node().init().start() as node:
         ...         print(node.execute('select 1'))
+        [(1,)]
     """
 
     try:

testgres/node.py

@@ -136,6 +136,10 @@ def __exit__(self, type, value, traceback):
         else:
             self._try_shutdown(attempts)
 
+    def __repr__(self):
+        return "{}(name='{}', port={}, base_dir='{}')".format(
+            self.__class__.__name__, self.name, self.port, self.base_dir)
+
     @property
     def pid(self):
         """

tests/test_simple.py

@@ -2,6 +2,7 @@
 # coding: utf-8
 
 import os
+import re
 import subprocess
 import tempfile
 import testgres
@@ -70,6 +71,11 @@ def removing(f):
 
 
 class TestgresTests(unittest.TestCase):
+    def test_node_repr(self):
+        with get_new_node() as node:
+            pattern = 'PostgresNode\(name=\'.+\', port=.+, base_dir=\'.+\'\)'
+            self.assertIsNotNone(re.match(pattern, str(node)))
+
     def test_custom_init(self):
         with get_new_node() as node:
             # enable page checksums