1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
# mapper/__init__.py
# Copyright (C) 2005 Michael Bayer mike_mp@zzzcomputing.com
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
"""
the mapper package provides object-relational functionality, building upon the schema and sql
packages and tying operations to class properties and constructors.
"""
import sqlalchemy.sql as sql
import sqlalchemy.schema as schema
import sqlalchemy.engine as engine
import sqlalchemy.util as util
import objectstore
from mapper import *
from properties import *
import mapper as mapperlib
__all__ = ['relation', 'eagerload', 'lazyload', 'noload', 'deferred', 'column',
'defer', 'undefer',
'mapper', 'clear_mappers', 'objectstore', 'sql', 'extension', 'class_mapper', 'object_mapper', 'MapperExtension',
'assign_mapper'
]
def relation(*args, **params):
"""provides a relationship of a primary Mapper to a secondary Mapper, which corresponds
to a parent-child or associative table relationship."""
if isinstance(args[0], type) and len(args) == 1:
return _relation_loader(*args, **params)
elif isinstance(args[0], Mapper):
return _relation_loader(*args, **params)
else:
return _relation_mapper(*args, **params)
def _relation_loader(mapper, secondary=None, primaryjoin=None, secondaryjoin=None, lazy=True, **kwargs):
if lazy:
return LazyLoader(mapper, secondary, primaryjoin, secondaryjoin, **kwargs)
elif lazy is None:
return PropertyLoader(mapper, secondary, primaryjoin, secondaryjoin, **kwargs)
else:
return EagerLoader(mapper, secondary, primaryjoin, secondaryjoin, **kwargs)
def _relation_mapper(class_, table=None, secondary=None,
primaryjoin=None, secondaryjoin=None,
foreignkey=None, uselist=None, private=False,
live=False, association=None, lazy=True,
selectalias=None, order_by=None, attributeext=None, **kwargs):
return _relation_loader(mapper(class_, table, **kwargs),
secondary, primaryjoin, secondaryjoin,
foreignkey=foreignkey, uselist=uselist, private=private,
live=live, association=association, lazy=lazy,
selectalias=selectalias, order_by=order_by, attributeext=attributeext)
def column(*columns, **kwargs):
return ColumnProperty(*columns, **kwargs)
def deferred(*columns, **kwargs):
return DeferredColumnProperty(*columns, **kwargs)
def mapper(class_, table = None, engine = None, autoload = False, *args, **params):
"""returns a new or already cached Mapper object."""
if table is None:
return class_mapper(class_)
if isinstance(table, str):
table = schema.Table(table, engine, autoload = autoload, mustexist = not autoload)
hashkey = mapper_hash_key(class_, table, *args, **params)
#print "HASHKEY: " + hashkey
try:
return mapper_registry[hashkey]
except KeyError:
m = Mapper(hashkey, class_, table, *args, **params)
mapper_registry.setdefault(hashkey, m)
m._init_properties()
return mapper_registry[hashkey]
def clear_mappers():
"""removes all mappers that have been created thus far. when new mappers are
created, they will be assigned to their classes as their primary mapper."""
mapper_registry.clear()
def clear_mapper(m):
"""removes the given mapper from the storage of mappers. when a new mapper is
created for the previous mapper's class, it will be used as that classes'
new primary mapper."""
del mapper_registry[m.hash_key]
def extension(ext):
"""returns a MapperOption that will add the given MapperExtension to the
mapper returned by mapper.options()."""
return ExtensionOption(ext)
def eagerload(name, **kwargs):
"""returns a MapperOption that will convert the property of the given name
into an eager load. Used with mapper.options()"""
return EagerLazyOption(name, toeager=True, **kwargs)
def lazyload(name, **kwargs):
"""returns a MapperOption that will convert the property of the given name
into a lazy load. Used with mapper.options()"""
return EagerLazyOption(name, toeager=False, **kwargs)
def noload(name, **kwargs):
"""returns a MapperOption that will convert the property of the given name
into a non-load. Used with mapper.options()"""
return EagerLazyOption(name, toeager=None, **kwargs)
def defer(name, **kwargs):
"""returns a MapperOption that will convert the column property of the given
name into a deferred load. Used with mapper.options()"""
return DeferredOption(name, defer=True)
def undefer(name, **kwargs):
"""returns a MapperOption that will convert the column property of the given
name into a non-deferred (regular column) load. Used with mapper.options."""
return DeferredOption(name, defer=False)
def object_mapper(object):
"""given an object, returns the primary Mapper associated with the object
or the object's class."""
return class_mapper(object.__class__)
def class_mapper(class_):
"""given a class, returns the primary Mapper associated with the class."""
try:
return mapper_registry[class_._mapper]
except KeyError:
pass
except AttributeError:
pass
raise "Class '%s' has no mapper associated with it" % class_.__name__
def assign_mapper(class_, *args, **params):
params.setdefault("is_primary", True)
m = mapper(class_, *args, **params)
class_.mapper = m
class_.get = m.get
class_.select = m.select
class_.select_by = m.select_by
class_.selectone = m.selectone
class_.get_by = m.get_by
def commit(self):
objectstore.commit(self)
def delete(self):
objectstore.delete(self)
class_.commit = commit
class_.delete = delete
|
