iro/model/dbdefer.py
author Sandro Knauß <knauss@netzguerilla.net>
Thu, 29 Mar 2012 17:21:46 +0200
branchdevel
changeset 259 5d9c24c2cb8d
parent 258 0a5eb5aac0be
child 294 0e75bd39767d
permissions -rw-r--r--
iro.model.utils: adding docstrings
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     1
from decorator import FunctionMaker
151
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
     2
import sqlalchemy
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     3
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     4
from .pool import runInDBPool
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     5
from .utils import WithSession
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     6
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     7
import inspect
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     8
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     9
class DBDefer(object):
258
0a5eb5aac0be iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents: 155
diff changeset
    10
    '''a twisted sqlalchemy connector.
0a5eb5aac0be iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents: 155
diff changeset
    11
    
0a5eb5aac0be iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents: 155
diff changeset
    12
    This is used as a Decorator class.
0a5eb5aac0be iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents: 155
diff changeset
    13
    It adds a session parameter to the function with a valid session.
0a5eb5aac0be iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents: 155
diff changeset
    14
    If the session parmaeter is used in calling this function only calls a commit after running the function, instead of createing a new session.'''
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    15
    def __init__(self, engine, autocommit=False):
258
0a5eb5aac0be iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents: 155
diff changeset
    16
        """
0a5eb5aac0be iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents: 155
diff changeset
    17
        :param `sqlalchemy.engine.base.Engine` engine: a valid sqlalchemy engine object (normally created via :func:`sqlalchemy.create_engine`).
0a5eb5aac0be iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents: 155
diff changeset
    18
        :param boolean autocommit: autocommit after running the function.
0a5eb5aac0be iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents: 155
diff changeset
    19
        """
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    20
        self.autocommit=autocommit
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    21
        self.engine = engine
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    22
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    23
    def __call__(self, func):
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    24
        @runInDBPool
123
2d685c3c10b2 dbdefer now can handle session argument on different positions
Sandro Knauß <knauss@netzguerilla.net>
parents: 117
diff changeset
    25
        def wrapper(func,*a, **kw):
151
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    26
            i = argspec.args.index("session")
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    27
            ab = a[:i]
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    28
            ae = a[i:-1]
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    29
            if isinstance(a[-1],sqlalchemy.orm.session.Session):
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    30
                al = ab + (a[-1],) + ae
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    31
                ret = func(*al, **kw)
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    32
                if self.autocommit:
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    33
                    a[-1].commit()
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    34
                return ret
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    35
            else:
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    36
                with WithSession(self.engine, self.autocommit) as session:
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    37
                    al = ab + (session,) + ae
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    38
                    return func(*al, **kw)
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    39
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    40
        caller=func
123
2d685c3c10b2 dbdefer now can handle session argument on different positions
Sandro Knauß <knauss@netzguerilla.net>
parents: 117
diff changeset
    41
        argspec = inspect.getargspec(caller)
2d685c3c10b2 dbdefer now can handle session argument on different positions
Sandro Knauß <knauss@netzguerilla.net>
parents: 117
diff changeset
    42
        args =[i for i in argspec.args if i != "session" ]
155
ff1edf7c1329 dbdefer now can be used for functions with no other argument than session
Sandro Knauß <knauss@netzguerilla.net>
parents: 151
diff changeset
    43
        sargs=", ".join(args)       
ff1edf7c1329 dbdefer now can be used for functions with no other argument than session
Sandro Knauß <knauss@netzguerilla.net>
parents: 151
diff changeset
    44
        if sargs:
ff1edf7c1329 dbdefer now can be used for functions with no other argument than session
Sandro Knauß <knauss@netzguerilla.net>
parents: 151
diff changeset
    45
            sargs+=", session"
ff1edf7c1329 dbdefer now can be used for functions with no other argument than session
Sandro Knauß <knauss@netzguerilla.net>
parents: 151
diff changeset
    46
        else:
ff1edf7c1329 dbdefer now can be used for functions with no other argument than session
Sandro Knauß <knauss@netzguerilla.net>
parents: 151
diff changeset
    47
            sargs="session"
151
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    48
        defaults = argspec.defaults
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    49
        if not defaults:
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    50
            defaults = (None,)
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    51
        else:
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    52
            defaults += (None,)
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    53
        evaldict = caller.func_globals.copy()
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    54
        evaldict['_call_'] = func
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    55
        evaldict['decorator'] = wrapper
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    56
        wrap = FunctionMaker.create(
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    57
              '%s(%s)' % (caller.__name__, sargs), 
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    58
              'return decorator(_call_, %s)' % sargs,
151
ff8448fb07e7 runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents: 123
diff changeset
    59
              evaldict, defaults=defaults, undecorated=caller, __wrapped__=caller,
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    60
              doc=caller.__doc__, module=caller.__module__, addsource=True)
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    61
        return wrap
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    62
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    63
dbdefer=DBDefer(None)
258
0a5eb5aac0be iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents: 155
diff changeset
    64
"""the decorator to use. Use :func:`setEngine` to set a valid engine after program has started."""
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    65
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    66
def setEngine(engine,autocommit=False): 
258
0a5eb5aac0be iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents: 155
diff changeset
    67
    """set the engine and autocommit for the decorator (see :class:`DBDefer`)."""
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    68
    dbdefer.engine = engine
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    69
    dbdefer.autocommit = autocommit
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    70
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    71