/usr/share/pyshared/sprox/saormprovider.py is in python-sprox 0.6.4-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 | """
saprovider Module
this contains the class which allows dbsprockets to interface with sqlalchemy.
Classes:
Name Description
SAProvider sqlalchemy metadata/crud provider
Exceptions:
None
Functions:
None
Copyright (c) 2007 Christopher Perkins
Original Version by Christopher Perkins 2007
Released under MIT license.
"""
import inspect
import re
from sqlalchemy import and_, or_, DateTime, Date, Interval, Binary, MetaData, desc as _desc
from sqlalchemy.engine import Engine
from sqlalchemy.orm.session import Session
from sqlalchemy.orm.scoping import ScopedSession
from sqlalchemy.orm import class_mapper, Mapper, PropertyLoader, _mapper_registry, SynonymProperty, object_mapper
from sqlalchemy.orm.exc import UnmappedClassError, NoResultFound, UnmappedInstanceError
from sprox.iprovider import IProvider
from cgi import FieldStorage
from datetime import datetime, timedelta
from warnings import warn
class SAORMProviderError(Exception):pass
class SAORMProvider(IProvider):
def __init__(self, hint=None, **hints):
"""
initialize me with a engine, bound metadata or bound session object
or a combination of the above.
"""
#if hint is None and len(hints) == 0:
# raise SAORMProviderError('You must provide a hint to this provider')
self.engine, self.session, self.metadata = self._get_engine(hint, hints)
def _get_engine(self, hint, hints):
metadata = hints.get('metadata', None)
engine = hints.get('engine', None)
session = hints.get('session', None)
if isinstance(hint, Engine):
engine=hint
if isinstance(hint, MetaData):
metadata=hint
if isinstance(hint, (Session, ScopedSession)):
session = hint
if session is not None and engine is None:
engine = session.bind
if metadata is not None and engine is None:
engine = metadata.bind
return engine, session, metadata
def get_fields(self, entity):
if inspect.isfunction(entity):
entity = entity()
mapper = class_mapper(entity)
field_names = mapper.c.keys()
for prop in mapper.iterate_properties:
try:
getattr(mapper.c, prop.key)
field_names.append(prop.key)
except AttributeError:
mapper.get_property(prop.key)
field_names.append(prop.key)
return field_names
def get_entity(self, name):
for mapper in _mapper_registry:
if mapper.class_.__name__ == name:
engine = mapper.tables[0].bind
if engine is not None and mapper.tables[0].bind != self.engine:
continue
return mapper.class_
raise KeyError('could not find model by the name %s'%(name))
def get_entities(self):
entities = []
for mapper in _mapper_registry:
engine = mapper.tables[0].bind
if engine is not None and mapper.tables[0].bind != self.engine:
continue
entities.append(mapper.class_.__name__)
return entities
def get_field(self, entity, name):
mapper = class_mapper(entity)
try:
return getattr(mapper.c, name)
except AttributeError:
return mapper.get_property(name)
def is_binary(self, entity, name):
field = self.get_field(entity, name)
if isinstance(field, PropertyLoader):
field = field.local_side[0]
# I am unsure what this is needed for, so it will be removed in the next version, and is for now
# commented until someone reports a bug.
#if not hasattr(field, 'type'):
# return False
return isinstance(field.type, Binary)
def is_nullable(self, entity, name):
field = self.get_field(entity, name)
if isinstance(field, SynonymProperty):
return
if isinstance(field, PropertyLoader):
return field.local_side[0].nullable
return field.nullable
def get_primary_fields(self, entity):
#for now we are only supporting entities with a single primary field
return [self.get_primary_field(entity)]
def get_primary_field(self, entity):
#sometimes entities get surrounded by functions, not sure why.
if inspect.isfunction(entity):
entity = entity()
mapper = class_mapper(entity)
for field_name in self.get_fields(entity):
value = getattr(mapper.c, field_name)
if value.primary_key:
return value.key
def get_view_field_name(self, entity, possible_names):
fields = self.get_fields(entity)
view_field = None
for column_name in possible_names:
for actual_name in fields:
if column_name == actual_name:
view_field = actual_name
break
if view_field:
break;
for actual_name in fields:
if column_name in actual_name:
view_field = actual_name
break
if view_field:
break;
if view_field is None:
view_field = fields[0]
return view_field
def get_dropdown_options(self, entity, field_name, view_names=None):
if view_names is None:
view_names = ['_name', 'name', 'description', 'title']
if self.session is None:
warn('No dropdown options will be shown for %s. '
'Try passing the session into the initialization'
'of your form base object so that this sprocket'
'can have values in the drop downs'%entity)
return []
field = self.get_field(entity, field_name)
target_field = entity
if isinstance(field, PropertyLoader):
target_field = field.argument
if inspect.isfunction(target_field):
target_field = target_field()
#some kind of relation
if isinstance(target_field, Mapper):
target_field = target_field.class_
pk_name = self.get_primary_field(target_field)
view_name = self.get_view_field_name(target_field, view_names)
rows = self.session.query(target_field).all()
return [(getattr(row, pk_name), getattr(row, view_name)) for row in rows]
def get_relations(self, entity):
mapper = class_mapper(entity)
return [prop.key for prop in mapper.iterate_properties if isinstance(prop, PropertyLoader)]
def is_relation(self, entity, field_name):
mapper = class_mapper(entity)
if isinstance(mapper.get_property(field_name), PropertyLoader):
return True
def is_unique(self, entity, field_name, value):
field = getattr(entity, field_name)
try:
self.session.query(entity).filter(field==value).one()
except NoResultFound:
return True
return False
def get_synonyms(self, entity):
mapper = class_mapper(entity)
return [prop.key for prop in mapper.iterate_properties if isinstance(prop, SynonymProperty)]
def _modify_params_for_relationships(self, entity, params, delete_first=True):
mapper = class_mapper(entity)
relations = self.get_relations(entity)
for relation in relations:
if relation in params:
prop = mapper.get_property(relation)
target = prop.argument
if inspect.isfunction(target):
target = target()
value = params[relation]
if value:
if prop.uselist and isinstance(value, list):
target_obj = []
for v in value:
try:
object_mapper(v)
target_obj.append(v)
except UnmappedInstanceError:
target_obj.append(self.session.query(target).get(v))
elif prop.uselist:
try:
object_mapper(value)
target_obj = [value]
except UnmappedInstanceError:
target_obj = [self.session.query(target).get(value)]
else:
try:
object_mapper(value)
target_obj = value
except UnmappedInstanceError:
target_obj = self.session.query(target).get(value)
params[relation] = target_obj
else:
del params[relation]
return params
def create(self, entity, params):
params = self._modify_params_for_dates(entity, params)
params = self._modify_params_for_relationships(entity, params)
obj = entity()
for key, value in params.iteritems():
if value is not None:
setattr(obj, key, value)
self.session.add(obj)
self.session.flush()
return obj
def dictify(self, obj):
if obj is None:
return {}
r = {}
mapper = class_mapper(obj.__class__)
for prop in mapper.iterate_properties:
value = getattr(obj, prop.key)
if value is not None:
if isinstance(prop, PropertyLoader):
klass = prop.argument
if isinstance(klass, Mapper):
klass = klass.class_
pk_name = self.get_primary_field(klass)
if isinstance(value, list):
#joins
value = [getattr(value, pk_name) for value in value]
else:
#fks
value = getattr(value, pk_name)
r[prop.key] = value
return r
def get_default_values(self, entity, params):
return params
def get(self, entity, params):
pk_name = self.get_primary_field(entity)
obj = self.session.query(entity).get(params[pk_name])
return self.dictify(obj)
def query(self, entity, limit=None, offset=None, limit_fields=None, order_by=None, desc=False, **kw):
query = self.session.query(entity)
count = query.count()
if order_by is not None:
field = self.get_field(entity, order_by)
if desc:
field = _desc(field)
query = query.order_by(field)
if offset is not None:
query = query.offset(offset)
if limit is not None:
query = query.limit(limit)
objs = query.all()
return count, objs
def _modify_params_for_dates(self, entity, params):
mapper = class_mapper(entity)
for key, value in params.iteritems():
if key in mapper.c and value is not None:
field = mapper.c[key]
if hasattr(field, 'type') and isinstance(field.type, DateTime) and not isinstance(value, datetime):
dt = datetime.strptime(value[:19], '%Y-%m-%d %H:%M:%S')
params[key] = dt
if hasattr(field, 'type') and isinstance(field.type, Date) and not isinstance(value, datetime):
dt = datetime.strptime(value, '%Y-%m-%d')
params[key] = dt
if hasattr(field, 'type') and isinstance(field.type, Interval) and not isinstance(value, timedelta):
d = re.match(
r'((?P<days>\d+) days, )?(?P<hours>\d+):'
r'(?P<minutes>\d+):(?P<seconds>\d+)',
str(value)).groupdict(0)
dt = timedelta(**dict(( (key, int(value))
for key, value in d.items() )))
params[key] = dt
return params
def _remove_related_empty_params(self, obj, params):
entity = obj.__class__
mapper = class_mapper(entity)
relations = self.get_relations(entity)
for relation in relations:
#clear out those items which are not found in the params list.
if relation not in params or not params[relation]:
related_items = getattr(obj, relation)
if related_items is not None:
if hasattr(related_items, '__iter__'):
setattr(obj, relation, [])
else:
setattr(obj, relation, None)
def update(self, entity, params):
params = self._modify_params_for_dates(entity, params)
params = self._modify_params_for_relationships(entity, params)
pk_name = self.get_primary_field(entity)
obj = self.session.query(entity).get(params[pk_name])
relations = self.get_relations(entity)
for key, value in params.iteritems():
setattr(obj, key, value)
self._remove_related_empty_params(obj, params)
self.session.flush()
return obj
def delete(self, entity, params):
pk_name = self.get_primary_field(entity)
obj = self.session.query(entity).get(params[pk_name])
self.session.delete(obj)
return obj
|