| author | Sandro Knauß <bugs@sandroknauss.de> |
| Tue, 15 Apr 2025 01:22:19 +0200 | |
| changeset 316 | 63c681b8e92c |
| parent 312 | 42fd5075a5d1 |
| permissions | -rw-r--r-- |
|
294
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
1 |
# Copyright (c) 2012 netzguerilla.net <iro@netzguerilla.net> |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
2 |
# |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
3 |
# This file is part of Iro. |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
4 |
# |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
5 |
# Permission is hereby granted, free of charge, to any person obtaining a copy of |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
6 |
# this software and associated documentation files (the "Software"), to deal in |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
7 |
# the Software without restriction, including without limitation the rights to use, |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
8 |
# copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
9 |
# #Software, and to permit persons to whom the Software is furnished to do so, |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
10 |
# subject to the following conditions: |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
11 |
# |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
12 |
# The above copyright notice and this permission notice shall be included in |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
13 |
# all copies or substantial portions of the Software. |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
14 |
# |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
15 |
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
16 |
# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
17 |
# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
18 |
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
19 |
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
20 |
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
258
diff
changeset
|
21 |
|
| 117 | 22 |
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
|
23 |
import sqlalchemy |
| 117 | 24 |
|
25 |
from .pool import runInDBPool |
|
26 |
from .utils import WithSession |
|
27 |
||
28 |
import inspect |
|
29 |
||
30 |
class DBDefer(object): |
|
|
258
0a5eb5aac0be
iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents:
155
diff
changeset
|
31 |
'''a twisted sqlalchemy connector. |
|
0a5eb5aac0be
iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents:
155
diff
changeset
|
32 |
|
|
0a5eb5aac0be
iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents:
155
diff
changeset
|
33 |
This is used as a Decorator class. |
|
0a5eb5aac0be
iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents:
155
diff
changeset
|
34 |
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
|
35 |
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 | 36 |
def __init__(self, engine, autocommit=False): |
|
258
0a5eb5aac0be
iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents:
155
diff
changeset
|
37 |
""" |
|
0a5eb5aac0be
iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents:
155
diff
changeset
|
38 |
: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
|
39 |
:param boolean autocommit: autocommit after running the function. |
|
0a5eb5aac0be
iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents:
155
diff
changeset
|
40 |
""" |
| 117 | 41 |
self.autocommit=autocommit |
42 |
self.engine = engine |
|
43 |
||
44 |
def __call__(self, func): |
|
45 |
@runInDBPool |
|
|
123
2d685c3c10b2
dbdefer now can handle session argument on different positions
Sandro Knauß <knauss@netzguerilla.net>
parents:
117
diff
changeset
|
46 |
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
|
47 |
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
|
48 |
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
|
49 |
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
|
50 |
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
|
51 |
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
|
52 |
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
|
53 |
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
|
54 |
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
|
55 |
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
|
56 |
else: |
|
ff8448fb07e7
runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents:
123
diff
changeset
|
57 |
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
|
58 |
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
|
59 |
return func(*al, **kw) |
| 117 | 60 |
|
61 |
caller=func |
|
| 312 | 62 |
argspec = inspect.getfullargspec(caller) |
|
123
2d685c3c10b2
dbdefer now can handle session argument on different positions
Sandro Knauß <knauss@netzguerilla.net>
parents:
117
diff
changeset
|
63 |
args =[i for i in argspec.args if i != "session" ] |
| 312 | 64 |
sargs=", ".join(args) |
|
155
ff1edf7c1329
dbdefer now can be used for functions with no other argument than session
Sandro Knauß <knauss@netzguerilla.net>
parents:
151
diff
changeset
|
65 |
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
|
66 |
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
|
67 |
else: |
|
ff1edf7c1329
dbdefer now can be used for functions with no other argument than session
Sandro Knauß <knauss@netzguerilla.net>
parents:
151
diff
changeset
|
68 |
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
|
69 |
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
|
70 |
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
|
71 |
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
|
72 |
else: |
|
ff8448fb07e7
runInDBThread and dbdefer can now handle if a valid session is an arg
Sandro Knauß <knauss@netzguerilla.net>
parents:
123
diff
changeset
|
73 |
defaults += (None,) |
| 312 | 74 |
evaldict = caller.__globals__.copy() |
| 117 | 75 |
evaldict['_call_'] = func |
76 |
evaldict['decorator'] = wrapper |
|
77 |
wrap = FunctionMaker.create( |
|
78 |
'%s(%s)' % (caller.__name__, sargs), |
|
79 |
'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
|
80 |
evaldict, defaults=defaults, undecorated=caller, __wrapped__=caller, |
| 117 | 81 |
doc=caller.__doc__, module=caller.__module__, addsource=True) |
82 |
return wrap |
|
83 |
||
84 |
dbdefer=DBDefer(None) |
|
|
258
0a5eb5aac0be
iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents:
155
diff
changeset
|
85 |
"""the decorator to use. Use :func:`setEngine` to set a valid engine after program has started.""" |
| 117 | 86 |
|
87 |
def setEngine(engine,autocommit=False): |
|
|
258
0a5eb5aac0be
iro.model: adding docstring
Sandro Knauß <knauss@netzguerilla.net>
parents:
155
diff
changeset
|
88 |
"""set the engine and autocommit for the decorator (see :class:`DBDefer`).""" |
| 117 | 89 |
dbdefer.engine = engine |
90 |
dbdefer.autocommit = autocommit |
|
91 |
||
92 |