Merge branch 'docfix'

Author: zilder

Diff for: LICENSE

@@ -1,6 +1,6 @@
 testgres is released under the PostgreSQL License, a liberal Open Source license, similar to the BSD or MIT licenses.
 
-Copyright (c) 2016-2017, Postgres Professional
+Copyright (c) 2016-2018, Postgres Professional
 
 Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.
 

Diff for: docs/source/testgres.rst

@@ -17,22 +17,6 @@ testgres.backup
     :undoc-members:
     :show-inheritance:
 
-testgres.cache
---------------
-
-.. automodule:: testgres.cache
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-testgres.config
----------------
-
-.. automodule:: testgres.config
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 testgres.connection
 -------------------
 
@@ -41,30 +25,6 @@ testgres.connection
     :undoc-members:
     :show-inheritance:
 
-testgres.consts
----------------
-
-.. automodule:: testgres.consts
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-testgres.decorators
--------------------
-
-.. automodule:: testgres.decorators
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-testgres.defaults
------------------
-
-.. automodule:: testgres.defaults
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 testgres.enums
 --------------
 
@@ -81,35 +41,13 @@ testgres.exceptions
     :undoc-members:
     :show-inheritance:
 
-testgres.logger
----------------
-
-.. automodule:: testgres.logger
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 testgres.node
 -------------
 
-.. automodule:: testgres.node
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-testgres.utils
---------------
-
-.. automodule:: testgres.utils
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+.. autoclass:: testgres.node.PostgresNode
+   :members:
 
-Module contents
----------------
+   .. automethod:: __init__
 
-.. automodule:: testgres
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. autoclass:: testgres.node.ProcessProxy
+   :members:

Diff for: testgres/api.py

@@ -29,16 +29,14 @@
 ...             print(replica.execute('postgres', 'select count(*) from test'))
 PostgresNode(name='...', port=..., base_dir='...')
 [(3,)]
-
-Copyright (c) 2016, Postgres Professional
 """
-
-from functools import wraps
-
 from .node import PostgresNode
 
 
-@wraps(PostgresNode.__init__)
 def get_new_node(name=None, base_dir=None, **kwargs):
+    """
+    Simply a wrapper around :class:`.PostgresNode` constructor.
+    See :meth:`.PostgresNode.__init__` for details.
+    """
     # NOTE: leave explicit 'name' and 'base_dir' for compatibility
     return PostgresNode(name=name, base_dir=base_dir, **kwargs)

Diff for: testgres/backup.py

@@ -43,7 +43,7 @@ def __init__(self,
         Create a new backup.
 
         Args:
-            node: PostgresNode we're going to backup.
+            node: :class:`.PostgresNode` we're going to backup.
             base_dir: where should we store it?
             username: database user name.
             xlog_method: none | fetch | stream (see docs)
@@ -136,7 +136,7 @@ def spawn_primary(self, name=None, destroy=True):
             destroy: should we convert this backup into a node?
 
         Returns:
-            New instance of PostgresNode.
+            New instance of :class:`.PostgresNode`.
         """
 
         # Prepare a data directory for this node
@@ -164,7 +164,7 @@ def spawn_replica(self, name=None, destroy=True, slot=None):
             destroy: should we convert this backup into a node?
 
         Returns:
-            New instance of PostgresNode.
+            New instance of :class:`.PostgresNode`.
         """
 
         # Build a new PostgresNode

Diff for: testgres/enums.py

@@ -4,7 +4,7 @@
 
 class XLogMethod(Enum):
     """
-    Available WAL methods for NodeBackup
+    Available WAL methods for :class:`.NodeBackup`
     """
 
     none = 'none'
@@ -14,7 +14,7 @@ class XLogMethod(Enum):
 
 class IsolationLevel(Enum):
     """
-    Transaction isolation level for NodeConnection
+    Transaction isolation level for :class:`.NodeConnection`
     """
 
     ReadUncommitted = 'read uncommitted'

Diff for: testgres/node.py

@@ -96,7 +96,7 @@ def __repr__(self):
 class PostgresNode(object):
     def __init__(self, name=None, port=None, base_dir=None):
         """
-        Create a new node.
+        PostgresNode constructor.
 
         Args:
             name: node's application name.
@@ -181,7 +181,7 @@ def auxiliary_pids(self):
     def auxiliary_processes(self):
         """
         Returns a list of auxiliary processes.
-        Each process is represented by ProcessProxy object.
+        Each process is represented by :class:`.ProcessProxy` object.
         """
 
         def is_aux(process):
@@ -193,7 +193,7 @@ def is_aux(process):
     def child_processes(self):
         """
         Returns a list of all child processes.
-        Each process is represented by ProcessProxy object.
+        Each process is represented by :class:`.ProcessProxy` object.
         """
 
         # get a list of postmaster's children
@@ -391,7 +391,7 @@ def init(self, initdb_params=None, **kwargs):
             allow_streaming: should this node add a hba entry for replication?
 
         Returns:
-            This instance of PostgresNode.
+            This instance of :class:`.PostgresNode`
         """
 
         # initialize this PostgreSQL node
@@ -420,7 +420,7 @@ def default_conf(self,
             log_statement: one of ('all', 'off', 'mod', 'ddl').
 
         Returns:
-            This instance of PostgresNode.
+            This instance of :class:`.PostgresNode`.
         """
 
         postgres_conf = os.path.join(self.data_dir, PG_CONF_FILE)
@@ -509,7 +509,7 @@ def append_conf(self, line, filename=PG_CONF_FILE):
             filename: config file (postgresql.conf by default).
 
         Returns:
-            This instance of PostgresNode.
+            This instance of :class:`.PostgresNode`.
         """
 
         config_name = os.path.join(self.data_dir, filename)
@@ -523,7 +523,7 @@ def status(self):
         Check this node's status.
 
         Returns:
-            An instance of NodeStatus.
+            An instance of :class:`.NodeStatus`.
         """
 
         try:
@@ -572,7 +572,7 @@ def start(self, params=[]):
             params: additional arguments for pg_ctl.
 
         Returns:
-            This instance of PostgresNode.
+            This instance of :class:`.PostgresNode`.
         """
 
         _params = [
@@ -602,7 +602,7 @@ def stop(self, params=[]):
             params: additional arguments for pg_ctl.
 
         Returns:
-            This instance of PostgresNode.
+            This instance of :class:`.PostgresNode`.
         """
 
         _params = [
@@ -626,7 +626,7 @@ def restart(self, params=[]):
             params: additional arguments for pg_ctl.
 
         Returns:
-            This instance of PostgresNode.
+            This instance of :class:`.PostgresNode`.
         """
 
         _params = [
@@ -656,7 +656,7 @@ def reload(self, params=[]):
             params: additional arguments for pg_ctl.
 
         Returns:
-            This instance of PostgresNode.
+            This instance of :class:`.PostgresNode`.
         """
 
         _params = [
@@ -706,7 +706,7 @@ def cleanup(self, max_attempts=3):
             max_attempts: how many times should we try to stop()?
 
         Returns:
-            This instance of PostgresNode.
+            This instance of :class:`.PostgresNode`.
         """
 
         self._try_shutdown(max_attempts)
@@ -1053,7 +1053,7 @@ def pgbench_init(self, **kwargs):
         Sets initialize=True.
 
         Returns:
-            This instance of PostgresNode.
+            This instance of :class:`.PostgresNode`.
         """
 
         self.pgbench_run(initialize=True, **kwargs)
@@ -1117,7 +1117,7 @@ def connect(self, dbname=None, username=None, password=None):
             password: user's password.
 
         Returns:
-            An instance of NodeConnection.
+            An instance of :class:`.NodeConnection`.
         """
 
         return NodeConnection(node=self,