Updated docs

Author: zilder

_sources/testgres.rst.txt

@@ -17,21 +17,14 @@ 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:
+    :member-order: groupwise
 
 testgres.connection
 -------------------
@@ -41,30 +34,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 +50,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:
+.. autoclass:: testgres.node.PostgresNode
+   :members:
 
-testgres.utils
---------------
+   .. automethod:: __init__
 
-.. automodule:: testgres.utils
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: testgres
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. autoclass:: testgres.node.ProcessProxy
+   :members:

genindex.html

@@ -34,7 +34,8 @@
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#A"><strong>A</strong></a>
+ <a href="#_"><strong>_</strong></a>
+ | <a href="#A"><strong>A</strong></a>
  | <a href="#B"><strong>B</strong></a>
  | <a href="#C"><strong>C</strong></a>
  | <a href="#D"><strong>D</strong></a>
@@ -44,7 +45,6 @@ <h1 id="index">Index</h1>
  | <a href="#I"><strong>I</strong></a>
  | <a href="#K"><strong>K</strong></a>
  | <a href="#L"><strong>L</strong></a>
- | <a href="#M"><strong>M</strong></a>
  | <a href="#N"><strong>N</strong></a>
  | <a href="#P"><strong>P</strong></a>
  | <a href="#Q"><strong>Q</strong></a>
@@ -56,6 +56,14 @@ <h1 id="index">Index</h1>
  | <a href="#X"><strong>X</strong></a>
 
 </div>
+<h2 id="_">_</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="testgres.html#testgres.node.PostgresNode.__init__">__init__() (testgres.node.PostgresNode method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -82,8 +90,6 @@ <h2 id="B">B</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="testgres.html#testgres.exceptions.BackupException">BackupException</a>
-</li>
-      <li><a href="testgres.html#testgres.node.PostgresNode.base_dir">base_dir (testgres.node.PostgresNode attribute)</a>
 </li>
       <li><a href="testgres.html#testgres.connection.NodeConnection.begin">begin() (testgres.connection.NodeConnection method)</a>
 </li>
@@ -93,15 +99,13 @@ <h2 id="B">B</h2>
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.config.GlobalConfig.cache_initdb">cache_initdb (testgres.config.GlobalConfig attribute)</a>, <a href="testgres.html#testgres.config.GlobalConfig.cache_initdb">[1]</a>
+      <li><a href="testgres.html#testgres.config.GlobalConfig.cache_initdb">cache_initdb (testgres.config.GlobalConfig attribute)</a>
 </li>
-      <li><a href="testgres.html#testgres.config.GlobalConfig.cache_pg_config">cache_pg_config (testgres.config.GlobalConfig attribute)</a>, <a href="testgres.html#testgres.config.GlobalConfig.cache_pg_config">[1]</a>
+      <li><a href="testgres.html#testgres.config.GlobalConfig.cache_pg_config">cache_pg_config (testgres.config.GlobalConfig attribute)</a>
 </li>
-      <li><a href="testgres.html#testgres.cache.cached_initdb">cached_initdb() (in module testgres.cache)</a>
+      <li><a href="testgres.html#testgres.config.GlobalConfig.cached_initdb_dir">cached_initdb_dir (testgres.config.GlobalConfig attribute)</a>
 </li>
-      <li><a href="testgres.html#testgres.config.GlobalConfig.cached_initdb_dir">cached_initdb_dir (testgres.config.GlobalConfig attribute)</a>, <a href="testgres.html#testgres.config.GlobalConfig.cached_initdb_dir">[1]</a>
-</li>
-      <li><a href="testgres.html#testgres.config.GlobalConfig.cached_initdb_unique">cached_initdb_unique (testgres.config.GlobalConfig attribute)</a>, <a href="testgres.html#testgres.config.GlobalConfig.cached_initdb_unique">[1]</a>
+      <li><a href="testgres.html#testgres.config.GlobalConfig.cached_initdb_unique">cached_initdb_unique (testgres.config.GlobalConfig attribute)</a>
 </li>
       <li><a href="testgres.html#testgres.node.PostgresNode.catchup">catchup() (testgres.node.PostgresNode method)</a>
 </li>
@@ -113,8 +117,6 @@ <h2 id="C">C</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.utils.clean_on_error">clean_on_error() (in module testgres.utils)</a>
-</li>
       <li><a href="testgres.html#testgres.backup.NodeBackup.cleanup">cleanup() (testgres.backup.NodeBackup method)</a>
 
       <ul>
@@ -141,16 +143,10 @@ <h2 id="C">C</h2>
 <h2 id="D">D</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.node.PostgresNode.data_dir">data_dir (testgres.node.PostgresNode attribute)</a>
-</li>
       <li><a href="testgres.html#testgres.node.PostgresNode.default_conf">default_conf() (testgres.node.PostgresNode method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.defaults.default_dbname">default_dbname() (in module testgres.defaults)</a>
-</li>
-      <li><a href="testgres.html#testgres.defaults.default_username">default_username() (in module testgres.defaults)</a>
-</li>
       <li><a href="testgres.html#testgres.node.PostgresNode.dump">dump() (testgres.node.PostgresNode method)</a>
 </li>
   </ul></td>
@@ -159,9 +155,7 @@ <h2 id="D">D</h2>
 <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.utils.eprint">eprint() (in module testgres.utils)</a>
-</li>
-      <li><a href="testgres.html#testgres.config.GlobalConfig.error_log_lines">error_log_lines (testgres.config.GlobalConfig attribute)</a>, <a href="testgres.html#testgres.config.GlobalConfig.error_log_lines">[1]</a>
+      <li><a href="testgres.html#testgres.config.GlobalConfig.error_log_lines">error_log_lines (testgres.config.GlobalConfig attribute)</a>
 </li>
       <li><a href="testgres.html#testgres.connection.NodeConnection.execute">execute() (testgres.connection.NodeConnection method)</a>
 
@@ -171,8 +165,6 @@ <h2 id="E">E</h2>
       </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.utils.execute_utility">execute_utility() (in module testgres.utils)</a>
-</li>
       <li><a href="testgres.html#testgres.exceptions.ExecUtilException">ExecUtilException</a>
 </li>
   </ul></td>
@@ -185,8 +177,6 @@ <h2 id="F">F</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.utils.file_tail">file_tail() (in module testgres.utils)</a>
-</li>
       <li><a href="testgres.html#testgres.node.PostgresNode.free_port">free_port() (testgres.node.PostgresNode method)</a>
 </li>
   </ul></td>
@@ -195,19 +185,11 @@ <h2 id="F">F</h2>
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.defaults.generate_app_name">generate_app_name() (in module testgres.defaults)</a>
-</li>
-      <li><a href="testgres.html#testgres.defaults.generate_system_id">generate_system_id() (in module testgres.defaults)</a>
-</li>
-      <li><a href="testgres.html#testgres.utils.get_bin_path">get_bin_path() (in module testgres.utils)</a>
+      <li><a href="testgres.html#testgres.node.PostgresNode.get_control_data">get_control_data() (testgres.node.PostgresNode method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.node.PostgresNode.get_control_data">get_control_data() (testgres.node.PostgresNode method)</a>
-</li>
-      <li><a href="testgres.html#testgres.utils.get_pg_config">get_pg_config() (in module testgres.utils)</a>
-</li>
-      <li><a href="testgres.html#testgres.utils.get_pg_version">get_pg_version() (in module testgres.utils)</a>
+      <li><a href="testgres.html#testgres.api.get_new_node">get_new_node() (in module testgres.api)</a>
 </li>
       <li><a href="testgres.html#testgres.config.GlobalConfig">GlobalConfig (class in testgres.config)</a>
 </li>
@@ -246,20 +228,6 @@ <h2 id="L">L</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="testgres.html#testgres.enums.ProcessType.LogicalReplicationLauncher">LogicalReplicationLauncher (testgres.enums.ProcessType attribute)</a>
-</li>
-      <li><a href="testgres.html#testgres.node.PostgresNode.logs_dir">logs_dir (testgres.node.PostgresNode attribute)</a>
-</li>
-  </ul></td>
-</tr></table>
-
-<h2 id="M">M</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.node.PostgresNode.master">master (testgres.node.PostgresNode attribute)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.decorators.method_decorator">method_decorator() (in module testgres.decorators)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -269,11 +237,11 @@ <h2 id="N">N</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="testgres.html#testgres.connection.NodeConnection.node">node (testgres.connection.NodeConnection attribute)</a>
 </li>
-      <li><a href="testgres.html#testgres.config.GlobalConfig.node_cleanup_full">node_cleanup_full (testgres.config.GlobalConfig attribute)</a>, <a href="testgres.html#testgres.config.GlobalConfig.node_cleanup_full">[1]</a>
+      <li><a href="testgres.html#testgres.config.GlobalConfig.node_cleanup_full">node_cleanup_full (testgres.config.GlobalConfig attribute)</a>
 </li>
-      <li><a href="testgres.html#testgres.config.GlobalConfig.node_cleanup_on_bad_exit">node_cleanup_on_bad_exit (testgres.config.GlobalConfig attribute)</a>, <a href="testgres.html#testgres.config.GlobalConfig.node_cleanup_on_bad_exit">[1]</a>
+      <li><a href="testgres.html#testgres.config.GlobalConfig.node_cleanup_on_bad_exit">node_cleanup_on_bad_exit (testgres.config.GlobalConfig attribute)</a>
 </li>
-      <li><a href="testgres.html#testgres.config.GlobalConfig.node_cleanup_on_good_exit">node_cleanup_on_good_exit (testgres.config.GlobalConfig attribute)</a>, <a href="testgres.html#testgres.config.GlobalConfig.node_cleanup_on_good_exit">[1]</a>
+      <li><a href="testgres.html#testgres.config.GlobalConfig.node_cleanup_on_good_exit">node_cleanup_on_good_exit (testgres.config.GlobalConfig attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -292,10 +260,6 @@ <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="testgres.html#testgres.node.PostgresNode.pg_ctl">pg_ctl() (testgres.node.PostgresNode method)</a>
-</li>
-      <li><a href="testgres.html#testgres.node.PostgresNode.pg_log_file">pg_log_file (testgres.node.PostgresNode attribute)</a>
-</li>
-      <li><a href="testgres.html#testgres.utils.pg_version_ge">pg_version_ge() (in module testgres.utils)</a>
 </li>
       <li><a href="testgres.html#testgres.node.PostgresNode.pgbench">pgbench() (testgres.node.PostgresNode method)</a>
 </li>
@@ -314,8 +278,6 @@ <h2 id="P">P</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="testgres.html#testgres.config.pop_config">pop_config() (in module testgres.config)</a>
-</li>
-      <li><a href="testgres.html#testgres.decorators.positional_args_hack">positional_args_hack() (in module testgres.decorators)</a>
 </li>
       <li><a href="testgres.html#testgres.node.PostgresNode">PostgresNode (class in testgres.node)</a>
 </li>
@@ -348,26 +310,20 @@ <h2 id="R">R</h2>
       <li><a href="testgres.html#testgres.enums.IsolationLevel.ReadCommitted">ReadCommitted (testgres.enums.IsolationLevel attribute)</a>
 </li>
       <li><a href="testgres.html#testgres.enums.IsolationLevel.ReadUncommitted">ReadUncommitted (testgres.enums.IsolationLevel attribute)</a>
-</li>
-      <li><a href="testgres.html#testgres.utils.release_port">release_port() (in module testgres.utils)</a>
 </li>
       <li><a href="testgres.html#testgres.node.PostgresNode.reload">reload() (testgres.node.PostgresNode method)</a>
 </li>
       <li><a href="testgres.html#testgres.enums.IsolationLevel.RepeatableRead">RepeatableRead (testgres.enums.IsolationLevel attribute)</a>
-</li>
-      <li><a href="testgres.html#testgres.node.PostgresNode.replicate">replicate() (testgres.node.PostgresNode method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.utils.reserve_port">reserve_port() (in module testgres.utils)</a>
+      <li><a href="testgres.html#testgres.node.PostgresNode.replicate">replicate() (testgres.node.PostgresNode method)</a>
 </li>
       <li><a href="testgres.html#testgres.node.PostgresNode.restart">restart() (testgres.node.PostgresNode method)</a>
 </li>
       <li><a href="testgres.html#testgres.node.PostgresNode.restore">restore() (testgres.node.PostgresNode method)</a>
 </li>
       <li><a href="testgres.html#testgres.connection.NodeConnection.rollback">rollback() (testgres.connection.NodeConnection method)</a>
-</li>
-      <li><a href="testgres.html#testgres.logger.TestgresLogger.run">run() (testgres.logger.TestgresLogger method)</a>
 </li>
       <li><a href="testgres.html#testgres.enums.NodeStatus.Running">Running (testgres.enums.NodeStatus attribute)</a>
 </li>
@@ -401,12 +357,8 @@ <h2 id="S">S</h2>
 </li>
       <li><a href="testgres.html#testgres.node.PostgresNode.status">status() (testgres.node.PostgresNode method)</a>
 </li>
-      <li><a href="testgres.html#testgres.logger.TestgresLogger.stop">stop() (testgres.logger.TestgresLogger method)</a>
-
-      <ul>
-        <li><a href="testgres.html#testgres.node.PostgresNode.stop">(testgres.node.PostgresNode method)</a>
+      <li><a href="testgres.html#testgres.node.PostgresNode.stop">stop() (testgres.node.PostgresNode method)</a>
 </li>
-      </ul></li>
       <li><a href="testgres.html#testgres.enums.NodeStatus.Stopped">Stopped (testgres.enums.NodeStatus attribute)</a>
 </li>
       <li><a href="testgres.html#testgres.enums.XLogMethod.stream">stream (testgres.enums.XLogMethod attribute)</a>
@@ -417,41 +369,23 @@ <h2 id="S">S</h2>
 <h2 id="T">T</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#testgres.config.GlobalConfig.temp_dir">temp_dir (testgres.config.GlobalConfig attribute)</a>, <a href="testgres.html#testgres.config.GlobalConfig.temp_dir">[1]</a>
-</li>
-      <li><a href="testgres.html#module-testgres">testgres (module)</a>
+      <li><a href="testgres.html#testgres.config.GlobalConfig.temp_dir">temp_dir (testgres.config.GlobalConfig attribute)</a>
 </li>
       <li><a href="testgres.html#module-testgres.api">testgres.api (module)</a>
 </li>
       <li><a href="testgres.html#module-testgres.backup">testgres.backup (module)</a>
-</li>
-      <li><a href="testgres.html#module-testgres.cache">testgres.cache (module)</a>
 </li>
       <li><a href="testgres.html#module-testgres.config">testgres.config (module)</a>
-</li>
-      <li><a href="testgres.html#module-testgres.connection">testgres.connection (module)</a>
-</li>
-      <li><a href="testgres.html#module-testgres.consts">testgres.consts (module)</a>
-</li>
-      <li><a href="testgres.html#module-testgres.decorators">testgres.decorators (module)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="testgres.html#module-testgres.defaults">testgres.defaults (module)</a>
+      <li><a href="testgres.html#module-testgres.connection">testgres.connection (module)</a>
 </li>
       <li><a href="testgres.html#module-testgres.enums">testgres.enums (module)</a>
 </li>
       <li><a href="testgres.html#module-testgres.exceptions">testgres.exceptions (module)</a>
-</li>
-      <li><a href="testgres.html#module-testgres.logger">testgres.logger (module)</a>
-</li>
-      <li><a href="testgres.html#module-testgres.node">testgres.node (module)</a>
-</li>
-      <li><a href="testgres.html#module-testgres.utils">testgres.utils (module)</a>
 </li>
       <li><a href="testgres.html#testgres.exceptions.TestgresException">TestgresException</a>
-</li>
-      <li><a href="testgres.html#testgres.logger.TestgresLogger">TestgresLogger (class in testgres.logger)</a>
 </li>
       <li><a href="testgres.html#testgres.exceptions.TimeoutException">TimeoutException</a>
 </li>
@@ -469,9 +403,7 @@ <h2 id="U">U</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="testgres.html#testgres.config.GlobalConfig.update">update() (testgres.config.GlobalConfig method)</a>
 </li>
-      <li><a href="testgres.html#testgres.config.GlobalConfig.use_python_logging">use_python_logging (testgres.config.GlobalConfig attribute)</a>, <a href="testgres.html#testgres.config.GlobalConfig.use_python_logging">[1]</a>
-</li>
-      <li><a href="testgres.html#testgres.node.PostgresNode.utils_log_file">utils_log_file (testgres.node.PostgresNode attribute)</a>
+      <li><a href="testgres.html#testgres.config.GlobalConfig.use_python_logging">use_python_logging (testgres.config.GlobalConfig attribute)</a>
 </li>
   </ul></td>
 </tr></table>