NotificationsYou must be signed in to change notification settings
Fork37
Star150

Commit51b0871

committed

Merge branch 'docfix'

2 parents0051f44 +f7bd228 commit51b0871Copy full SHA for 51b0871

File tree

6 files changed

+29

-93

lines changed

6 files changed

+29

-93

lines changed

`‎LICENSE‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`testgres is released under the PostgreSQL License, a liberal Open Source license, similar to the BSD or MIT licenses.`
`2`	`2`
`3`		`-Copyright (c) 2016-2017, Postgres Professional`
	`3`	`+Copyright (c) 2016-2018, Postgres Professional`
`4`	`4`
`5`	`5`	`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.`
`6`	`6`

`‎docs/source/testgres.rst‎`

Lines changed: 5 additions & 67 deletions

Original file line number	Diff line number	Diff line change
`@@ -17,22 +17,6 @@ testgres.backup`
`17`	`17`	`:undoc-members:`
`18`	`18`	`:show-inheritance:`
`19`	`19`
`20`		`-testgres.cache`
`21`		`---------------`
`22`		`-`
`23`		`-..automodule::testgres.cache`
`24`		`-:members:`
`25`		`-:undoc-members:`
`26`		`-:show-inheritance:`
`27`		`-`
`28`		`-testgres.config`
`29`		`----------------`
`30`		`-`
`31`		`-..automodule::testgres.config`
`32`		`-:members:`
`33`		`-:undoc-members:`
`34`		`-:show-inheritance:`
`35`		`-`
`36`	`20`	`testgres.connection`
`37`	`21`	`-------------------`
`38`	`22`
`@@ -41,30 +25,6 @@ testgres.connection`
`41`	`25`	`:undoc-members:`
`42`	`26`	`:show-inheritance:`
`43`	`27`
`44`		`-testgres.consts`
`45`		`----------------`
`46`		`-`
`47`		`-..automodule::testgres.consts`
`48`		`-:members:`
`49`		`-:undoc-members:`
`50`		`-:show-inheritance:`
`51`		`-`
`52`		`-testgres.decorators`
`53`		`--------------------`
`54`		`-`
`55`		`-..automodule::testgres.decorators`
`56`		`-:members:`
`57`		`-:undoc-members:`
`58`		`-:show-inheritance:`
`59`		`-`
`60`		`-testgres.defaults`
`61`		`------------------`
`62`		`-`
`63`		`-..automodule::testgres.defaults`
`64`		`-:members:`
`65`		`-:undoc-members:`
`66`		`-:show-inheritance:`
`67`		`-`
`68`	`28`	`testgres.enums`
`69`	`29`	`--------------`
`70`	`30`
`@@ -81,35 +41,13 @@ testgres.exceptions`
`81`	`41`	`:undoc-members:`
`82`	`42`	`:show-inheritance:`
`83`	`43`
`84`		`-testgres.logger`
`85`		`----------------`
`86`		`-`
`87`		`-..automodule::testgres.logger`
`88`		`-:members:`
`89`		`-:undoc-members:`
`90`		`-:show-inheritance:`
`91`		`-`
`92`	`44`	`testgres.node`
`93`	`45`	`-------------`
`94`	`46`
`95`		`-..automodule::testgres.node`
`96`		`-:members:`
`97`		`-:undoc-members:`
`98`		`-:show-inheritance:`
`99`		`-`
`100`		`-testgres.utils`
`101`		`---------------`
`102`		`-`
`103`		`-..automodule::testgres.utils`
`104`		`-:members:`
`105`		`-:undoc-members:`
`106`		`-:show-inheritance:`
`107`		`-`
	`47`	`+..autoclass::testgres.node.PostgresNode`
	`48`	`+:members:`
`108`	`49`
`109`		`-Module contents`
`110`		`----------------`
	`50`	`+ ..automethod::__init__`
`111`	`51`
`112`		`-..automodule::testgres`
`113`		`-:members:`
`114`		`-:undoc-members:`
`115`		`-:show-inheritance:`
	`52`	`+..autoclass::testgres.node.ProcessProxy`
	`53`	`+:members:`

`‎testgres/api.py‎`

Lines changed: 4 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -29,16 +29,14 @@`
`29`	`29`	`... print(replica.execute('postgres', 'select count(*) from test'))`
`30`	`30`	`PostgresNode(name='...', port=..., base_dir='...')`
`31`	`31`	`[(3,)]`
`32`		`-`
`33`		`-Copyright (c) 2016, Postgres Professional`
`34`	`32`	`"""`
`35`		`-`
`36`		`-fromfunctoolsimportwraps`
`37`		`-`
`38`	`33`	`from .nodeimportPostgresNode`
`39`	`34`
`40`	`35`
`41`		`-@wraps(PostgresNode.__init__)`
`42`	`36`	`defget_new_node(name=None,base_dir=None,**kwargs):`
	`37`	`+"""`
	`38`	+ Simply a wrapper around :class:`.PostgresNode` constructor.
	`39`	+ See :meth:`.PostgresNode.__init__` for details.
	`40`	`+ """`
`43`	`41`	`# NOTE: leave explicit 'name' and 'base_dir' for compatibility`
`44`	`42`	`returnPostgresNode(name=name,base_dir=base_dir,**kwargs)`

`‎testgres/backup.py‎`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ def __init__(self,`
`43`	`43`	`Create a new backup.`
`44`	`44`
`45`	`45`	`Args:`
`46`		`- node: PostgresNode we're going to backup.`
	`46`	+ node::class:`.PostgresNode` we're going to backup.
`47`	`47`	`base_dir: where should we store it?`
`48`	`48`	`username: database user name.`
`49`	`49`	`xlog_method: none \| fetch \| stream (see docs)`
`@@ -136,7 +136,7 @@ def spawn_primary(self, name=None, destroy=True):`
`136`	`136`	`destroy: should we convert this backup into a node?`
`137`	`137`
`138`	`138`	`Returns:`
`139`		`- New instance of PostgresNode.`
	`139`	+ New instance of:class:`.PostgresNode`.
`140`	`140`	`"""`
`141`	`141`
`142`	`142`	`# Prepare a data directory for this node`
`@@ -164,7 +164,7 @@ def spawn_replica(self, name=None, destroy=True, slot=None):`
`164`	`164`	`destroy: should we convert this backup into a node?`
`165`	`165`
`166`	`166`	`Returns:`
`167`		`- New instance of PostgresNode.`
	`167`	+ New instance of:class:`.PostgresNode`.
`168`	`168`	`"""`
`169`	`169`
`170`	`170`	`# Build a new PostgresNode`

`‎testgres/enums.py‎`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`classXLogMethod(Enum):`
`6`	`6`	`"""`
`7`		`- Available WAL methods for NodeBackup`
	`7`	+ Available WAL methods for:class:`.NodeBackup`
`8`	`8`	`"""`
`9`	`9`
`10`	`10`	`none='none'`
`@@ -14,7 +14,7 @@ class XLogMethod(Enum):`
`14`	`14`
`15`	`15`	`classIsolationLevel(Enum):`
`16`	`16`	`"""`
`17`		`- Transaction isolation level for NodeConnection`
	`17`	+ Transaction isolation level for:class:`.NodeConnection`
`18`	`18`	`"""`
`19`	`19`
`20`	`20`	`ReadUncommitted='read uncommitted'`

`‎testgres/node.py‎`

Lines changed: 14 additions & 14 deletions

Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ def __repr__(self):`
`96`	`96`	`classPostgresNode(object):`
`97`	`97`	`def__init__(self,name=None,port=None,base_dir=None):`
`98`	`98`	`"""`
`99`		`-Create a new node.`
	`99`	`+PostgresNode constructor.`
`100`	`100`
`101`	`101`	`Args:`
`102`	`102`	`name: node's application name.`
`@@ -181,7 +181,7 @@ def auxiliary_pids(self):`
`181`	`181`	`defauxiliary_processes(self):`
`182`	`182`	`"""`
`183`	`183`	`Returns a list of auxiliary processes.`
`184`		`- Each process is represented by ProcessProxy object.`
	`184`	+ Each process is represented by:class:`.ProcessProxy` object.
`185`	`185`	`"""`
`186`	`186`
`187`	`187`	`defis_aux(process):`
`@@ -193,7 +193,7 @@ def is_aux(process):`
`193`	`193`	`defchild_processes(self):`
`194`	`194`	`"""`
`195`	`195`	`Returns a list of all child processes.`
`196`		`- Each process is represented by ProcessProxy object.`
	`196`	+ Each process is represented by:class:`.ProcessProxy` object.
`197`	`197`	`"""`
`198`	`198`
`199`	`199`	`# get a list of postmaster's children`
`@@ -391,7 +391,7 @@ def init(self, initdb_params=None, **kwargs):`
`391`	`391`	`allow_streaming: should this node add a hba entry for replication?`
`392`	`392`
`393`	`393`	`Returns:`
`394`		`- This instance ofPostgresNode.`
	`394`	+ This instance of:class:`.PostgresNode`
`395`	`395`	`"""`
`396`	`396`
`397`	`397`	`# initialize this PostgreSQL node`
`@@ -420,7 +420,7 @@ def default_conf(self,`
`420`	`420`	`log_statement: one of ('all', 'off', 'mod', 'ddl').`
`421`	`421`
`422`	`422`	`Returns:`
`423`		`- This instance of PostgresNode.`
	`423`	+ This instance of:class:`.PostgresNode`.
`424`	`424`	`"""`
`425`	`425`
`426`	`426`	`postgres_conf=os.path.join(self.data_dir,PG_CONF_FILE)`
`@@ -509,7 +509,7 @@ def append_conf(self, line, filename=PG_CONF_FILE):`
`509`	`509`	`filename: config file (postgresql.conf by default).`
`510`	`510`
`511`	`511`	`Returns:`
`512`		`- This instance of PostgresNode.`
	`512`	+ This instance of:class:`.PostgresNode`.
`513`	`513`	`"""`
`514`	`514`
`515`	`515`	`config_name=os.path.join(self.data_dir,filename)`
`@@ -523,7 +523,7 @@ def status(self):`
`523`	`523`	`Check this node's status.`
`524`	`524`
`525`	`525`	`Returns:`
`526`		`- An instance of NodeStatus.`
	`526`	+ An instance of:class:`.NodeStatus`.
`527`	`527`	`"""`
`528`	`528`
`529`	`529`	`try:`
`@@ -572,7 +572,7 @@ def start(self, params=[]):`
`572`	`572`	`params: additional arguments for pg_ctl.`
`573`	`573`
`574`	`574`	`Returns:`
`575`		`- This instance of PostgresNode.`
	`575`	+ This instance of:class:`.PostgresNode`.
`576`	`576`	`"""`
`577`	`577`
`578`	`578`	`_params= [`
`@@ -602,7 +602,7 @@ def stop(self, params=[]):`
`602`	`602`	`params: additional arguments for pg_ctl.`
`603`	`603`
`604`	`604`	`Returns:`
`605`		`- This instance of PostgresNode.`
	`605`	+ This instance of:class:`.PostgresNode`.
`606`	`606`	`"""`
`607`	`607`
`608`	`608`	`_params= [`
`@@ -626,7 +626,7 @@ def restart(self, params=[]):`
`626`	`626`	`params: additional arguments for pg_ctl.`
`627`	`627`
`628`	`628`	`Returns:`
`629`		`- This instance of PostgresNode.`
	`629`	+ This instance of:class:`.PostgresNode`.
`630`	`630`	`"""`
`631`	`631`
`632`	`632`	`_params= [`
`@@ -656,7 +656,7 @@ def reload(self, params=[]):`
`656`	`656`	`params: additional arguments for pg_ctl.`
`657`	`657`
`658`	`658`	`Returns:`
`659`		`- This instance of PostgresNode.`
	`659`	+ This instance of:class:`.PostgresNode`.
`660`	`660`	`"""`
`661`	`661`
`662`	`662`	`_params= [`
`@@ -706,7 +706,7 @@ def cleanup(self, max_attempts=3):`
`706`	`706`	`max_attempts: how many times should we try to stop()?`
`707`	`707`
`708`	`708`	`Returns:`
`709`		`- This instance of PostgresNode.`
	`709`	+ This instance of:class:`.PostgresNode`.
`710`	`710`	`"""`
`711`	`711`
`712`	`712`	`self._try_shutdown(max_attempts)`
`@@ -1053,7 +1053,7 @@ def pgbench_init(self, **kwargs):`
`1053`	`1053`	`Sets initialize=True.`
`1054`	`1054`
`1055`	`1055`	`Returns:`
`1056`		`- This instance of PostgresNode.`
	`1056`	+ This instance of:class:`.PostgresNode`.
`1057`	`1057`	`"""`
`1058`	`1058`
`1059`	`1059`	`self.pgbench_run(initialize=True,**kwargs)`
`@@ -1117,7 +1117,7 @@ def connect(self, dbname=None, username=None, password=None):`
`1117`	`1117`	`password: user's password.`
`1118`	`1118`
`1119`	`1119`	`Returns:`
`1120`		`- An instance of NodeConnection.`
	`1120`	+ An instance of:class:`.NodeConnection`.
`1121`	`1121`	`"""`
`1122`	`1122`
`1123`	`1123`	`returnNodeConnection(node=self,`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit51b0871

File tree

6 files changed

6 files changed

`‎LICENSE‎`

`‎docs/source/testgres.rst‎`

`‎testgres/api.py‎`

`‎testgres/backup.py‎`

`‎testgres/enums.py‎`

`‎testgres/node.py‎`

0 commit comments