move some code to dedicated modules

Author: funbringer

testgres/backup.py

@@ -16,11 +16,12 @@
     BACKUP_LOG_FILE, \
     DEFAULT_XLOG_METHOD
 
+from .defaults import default_username
+
 from .exceptions import BackupException
 
 from .utils import \
     get_bin_path, \
-    default_username, \
     execute_utility
 
 

testgres/cache.py

@@ -10,14 +10,15 @@
 
 from .consts import XLOG_CONTROL_FILE
 
+from .defaults import generate_system_id
+
 from .exceptions import \
     InitNodeException, \
     ExecUtilException
 
 from .utils import \
     get_bin_path, \
-    execute_utility, \
-    generate_system_id
+    execute_utility
 
 
 def cached_initdb(data_dir, logfile=None, params=None):

testgres/connection.py

@@ -9,13 +9,14 @@
     except ImportError:
         raise ImportError("You must have psycopg2 or pg8000 modules installed")
 
+from .defaults import \
+    default_dbname, \
+    default_username
+
 from enum import Enum
 
 from .exceptions import QueryException
 
-from .utils import \
-    default_dbname, \
-    default_username
 
 # export these exceptions
 InternalError = pglib.InternalError

testgres/decorators.py

@@ -0,0 +1,74 @@
+import six
+import functools
+
+
+def positional_args_hack(*special_cases):
+    """
+    Convert positional args described by
+    'special_cases' into named args.
+
+    Example:
+        @positional_args_hack(['abc'], ['def', 'abc'])
+        def some_api_func(...)
+
+    This is useful for compatibility.
+    """
+
+    cases = dict()
+
+    for case in special_cases:
+        k = len(case)
+        assert k not in six.iterkeys(cases), 'len must be unique'
+        cases[k] = case
+
+    def decorator(function):
+        @functools.wraps(function)
+        def wrapper(*args, **kwargs):
+            k = len(args)
+
+            if k in six.iterkeys(cases):
+                case = cases[k]
+
+                for i in range(0, k):
+                    arg_name = case[i]
+                    arg_val = args[i]
+
+                    # transform into named
+                    kwargs[arg_name] = arg_val
+
+                # get rid of them
+                args = []
+
+            return function(*args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
+def method_decorator(decorator):
+    """
+    Convert a function decorator into a method decorator.
+    """
+
+    def _dec(func):
+        def _wrapper(self, *args, **kwargs):
+            @decorator
+            def bound_func(*args2, **kwargs2):
+                return func.__get__(self, type(self))(*args2, **kwargs2)
+
+            # 'bound_func' is a closure and can see 'self'
+            return bound_func(*args, **kwargs)
+
+        # preserve docs
+        functools.update_wrapper(_wrapper, func)
+
+        return _wrapper
+
+    # preserve docs
+    functools.update_wrapper(_dec, decorator)
+
+    # change name for easier debugging
+    _dec.__name__ = 'method_decorator({})'.format(decorator.__name__)
+
+    return _dec

testgres/defaults.py

@@ -0,0 +1,50 @@
+import datetime
+import getpass
+import os
+import struct
+import uuid
+
+
+def default_dbname():
+    """
+    Return default DB name.
+    """
+
+    return 'postgres'
+
+
+def default_username():
+    """
+    Return default username (current user).
+    """
+
+    return getpass.getuser()
+
+
+def generate_app_name():
+    """
+    Generate a new application name for node.
+    """
+
+    return 'testgres-{}'.format(str(uuid.uuid4()))
+
+
+def generate_system_id():
+    """
+    Generate a new 64-bit unique system identifier for node.
+    """
+
+    date1 = datetime.datetime.utcfromtimestamp(0)
+    date2 = datetime.datetime.utcnow()
+
+    secs = int((date2 - date1).total_seconds())
+    usecs = date2.microsecond
+
+    # see pg_resetwal.c : GuessControlValues()
+    system_id = 0
+    system_id |= (secs << 32)
+    system_id |= (usecs << 12)
+    system_id |= (os.getpid() & 0xFFF)
+
+    # pack ULL in native byte order
+    return struct.pack('=Q', system_id)

testgres/node.py

@@ -33,6 +33,15 @@
     UTILS_LOG_FILE, \
     DEFAULT_XLOG_METHOD
 
+from .decorators import \
+    method_decorator, \
+    positional_args_hack
+
+from .defaults import \
+    default_dbname, \
+    default_username, \
+    generate_app_name
+
 from .exceptions import \
     CatchUpException,   \
     ExecUtilException,  \
@@ -49,12 +58,7 @@
     pg_version_ge, \
     reserve_port, \
     release_port, \
-    default_dbname, \
-    default_username, \
-    generate_app_name, \
-    execute_utility, \
-    method_decorator, \
-    positional_args_hack
+    execute_utility
 
 
 class NodeStatus(Enum):

testgres/utils.py

@@ -3,11 +3,9 @@
 from __future__ import division
 from __future__ import print_function
 
-import functools
 import io
 import os
 import port_for
-import six
 import subprocess
 import sys
 
@@ -16,6 +14,7 @@
 from .config import testgres_config
 from .exceptions import ExecUtilException
 
+
 # rows returned by PG_CONFIG
 _pg_config_data = {}
 
@@ -42,56 +41,6 @@ def release_port(port):
     bound_ports.remove(port)
 
 
-def default_dbname():
-    """
-    Return default DB name.
-    """
-
-    return 'postgres'
-
-
-def default_username():
-    """
-    Return default username (current user).
-    """
-
-    import getpass
-    return getpass.getuser()
-
-
-def generate_app_name():
-    """
-    Generate a new application name for node.
-    """
-
-    import uuid
-    return 'testgres-{}'.format(str(uuid.uuid4()))
-
-
-def generate_system_id():
-    """
-    Generate a new 64-bit unique system identifier for node.
-    """
-
-    import datetime
-    import struct
-
-    date1 = datetime.datetime.utcfromtimestamp(0)
-    date2 = datetime.datetime.utcnow()
-
-    secs = int((date2 - date1).total_seconds())
-    usecs = date2.microsecond
-
-    # see pg_resetwal.c : GuessControlValues()
-    system_id = 0
-    system_id |= (secs << 32)
-    system_id |= (usecs << 12)
-    system_id |= (os.getpid() & 0xFFF)
-
-    # pack ULL in native byte order
-    return struct.pack('=Q', system_id)
-
-
 def execute_utility(args, logfile=None):
     """
     Execute utility (pg_ctl, pg_dump etc).
@@ -268,77 +217,5 @@ def file_tail(f, num_lines):
         buffers = int(buffers * max(2, num_lines / max(cur_lines, 1)))
 
 
-def positional_args_hack(*special_cases):
-    """
-    Convert positional args described by
-    'special_cases' into named args.
-
-    Example:
-        @positional_args_hack(['abc'], ['def', 'abc'])
-        def some_api_func(...)
-
-    This is useful for compatibility.
-    """
-
-    cases = dict()
-
-    for case in special_cases:
-        k = len(case)
-        assert k not in six.iterkeys(cases), 'len must be unique'
-        cases[k] = case
-
-    def decorator(function):
-        @functools.wraps(function)
-        def wrapper(*args, **kwargs):
-            k = len(args)
-
-            if k in six.iterkeys(cases):
-                case = cases[k]
-
-                for i in range(0, k):
-                    arg_name = case[i]
-                    arg_val = args[i]
-
-                    # transform into named
-                    kwargs[arg_name] = arg_val
-
-                # get rid of them
-                args = []
-
-            return function(*args, **kwargs)
-
-        return wrapper
-
-    return decorator
-
-
-def method_decorator(decorator):
-    """
-    Convert a function decorator into a method decorator.
-    """
-
-    def _dec(func):
-        def _wrapper(self, *args, **kwargs):
-            @decorator
-            def bound_func(*args2, **kwargs2):
-                return func.__get__(self, type(self))(*args2, **kwargs2)
-
-            # 'bound_func' is a closure and can see 'self'
-            return bound_func(*args, **kwargs)
-
-        # preserve docs
-        functools.update_wrapper(_wrapper, func)
-
-        return _wrapper
-
-    # preserve docs
-    functools.update_wrapper(_dec, decorator)
-
-    # change name for easier debugging
-    _dec.__name__ = 'method_decorator({})'.format(decorator.__name__)
-
-    return _dec
-
-
 def eprint(*args, **kwargs):
     print(*args, file=sys.stderr, **kwargs)