Mar 22, 2018 · Mar 21, 2018 · Mar 22, 2018 · Mar 22, 2018 · Mar 21, 2018 · Mar 21, 2018
diff --git a/testgres/api.py b/testgres/api.py
 edit configuration files, start/stop cluster, execute queries. The
 typical flow may look like:

 >>> with get_new_node() as node:
 >>> with get_new_node('test') as node:
 ...     node.init().start()
 ...     result = node.safe_psql('postgres', 'select 1')
 ...     print(result.decode('utf-8').strip())
 ...     node.stop()
 <testgres.node.PostgresNode object at 0x...>
 PostgresNode('test', port=..., base_dir=...)
 1
 <testgres.node.PostgresNode object at 0x...>
 PostgresNode('test', port=..., base_dir=...)

    Or:

 >>> with get_new_node() as master:
 >>> with get_new_node('master') as master:
 ...     master.init().start()
 ...     with master.backup() as backup:
 ...         with backup.spawn_replica() as replica:
 ...         with backup.spawn_replica('replica') as replica:
 ...             replica = replica.start()
 ...             master.execute('postgres', 'create table test (val int4)')
 ...             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('master', port=..., base_dir=...)
 [(3,)]

 Copyright (c) 2016, Postgres Professional
diff --git a/testgres/config.py b/testgres/config.py
    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:
diff --git a/testgres/node.py b/testgres/node.py
        else:
            self._try_shutdown(attempts)

    def __repr__(self):
        return "PostgresNode('{}', port={}, base_dir={})".format(
            self.name, self.port, self.base_dir)

    @property
    def pid(self):
        """
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,27 +7,27 @@
		edit configuration files, start/stop cluster, execute queries. The
		typical flow may look like:

		>>> with get_new_node() as node:
		>>> with get_new_node('test') as node:
Copy link Collaborator funbringerMar 21, 2018• edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. IMHO it's better to have at least one example with no args at all. It would show user that literally every arg of`get_new_node()` has a decent default. Copy link CollaboratorAuthor zilderMar 22, 2018 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Fair enough
		... node.init().start()
		... result = node.safe_psql('postgres', 'select 1')
		... print(result.decode('utf-8').strip())
		... node.stop()
		<testgres.node.PostgresNode object at 0x...>
		PostgresNode('test', port=..., base_dir=...)
Copy link Collaborator funbringerMar 21, 2018 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. I believe that`'test'` should be prefixed by`name=`. Copy link CollaboratorAuthor zilderMar 22, 2018 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. I personally disagree as it makes the whole output 5 symbols larger, but I can make my peace with that : )
		1
		<testgres.node.PostgresNode object at 0x...>
		PostgresNode('test', port=..., base_dir=...)

		Or:

		>>> with get_new_node() as master:
		>>> with get_new_node('master') as master:
		... master.init().start()
		... with master.backup() as backup:
		... with backup.spawn_replica() as replica:
		... with backup.spawn_replica('replica') as replica:
		... replica = replica.start()
		... master.execute('postgres', 'create table test (val int4)')
		... 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('master', port=..., base_dir=...)
		[(3,)]

		Copyright (c) 2016, Postgres Professional
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -135,6 +135,10 @@ def __exit__(self, type, value, traceback):
		else:
		self._try_shutdown(attempts)

		def __repr__(self):
		return "PostgresNode('{}', port={}, base_dir={})".format(
		self.name, self.port, self.base_dir)

		@property
		def pid(self):
		"""
Expand Down