From 39dc3bf8db4a0a21220560a259574da4f2c1e12a Mon Sep 17 00:00:00 2001 From: Sebastian Spaeth Date: Mon, 7 Jan 2013 13:03:51 +0100 Subject: Mv db.sql.base to db.base This concludes the db.sql.* -> db.* move. Our db abstraction layer is sqlalchemy, so there is no need to a separate db.sql.* hierarchy. All tests have been run for each of the commit series to make sure everything works at every step. --- mediagoblin/db/base.py | 91 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 mediagoblin/db/base.py (limited to 'mediagoblin/db/base.py') diff --git a/mediagoblin/db/base.py b/mediagoblin/db/base.py new file mode 100644 index 00000000..3530011e --- /dev/null +++ b/mediagoblin/db/base.py @@ -0,0 +1,91 @@ +# GNU MediaGoblin -- federated, autonomous media hosting +# Copyright (C) 2011, 2012 MediaGoblin contributors. See AUTHORS. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + + +from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.orm import scoped_session, sessionmaker, object_session +from sqlalchemy.orm.query import Query + +def _get_query_model(query): + cols = query.column_descriptions + assert len(cols) == 1, "These functions work only on simple queries" + return cols[0]["type"] + + +class GMGQuery(Query): + def sort(self, key): + key_col = getattr(_get_query_model(self), key) + return self.order_by(key_col) + + +Session = scoped_session(sessionmaker(query_cls=GMGQuery)) + + +class GMGTableBase(object): + query = Session.query_property() + + @classmethod + def find(cls, query_dict): + return cls.query.filter_by(**query_dict) + + @classmethod + def find_one(cls, query_dict): + return cls.query.filter_by(**query_dict).first() + + @classmethod + def one(cls, query_dict): + return cls.find(query_dict).one() + + def get(self, key): + return getattr(self, key) + + def setdefault(self, key, defaultvalue): + # The key *has* to exist on sql. + return getattr(self, key) + + def save(self): + sess = object_session(self) + if sess is None: + sess = Session() + sess.add(self) + sess.commit() + + def delete(self, commit=True): + """Delete the object and commit the change immediately by default""" + sess = object_session(self) + assert sess is not None, "Not going to delete detached %r" % self + sess.delete(self) + if commit: + sess.commit() + + +Base = declarative_base(cls=GMGTableBase) + + +class DictReadAttrProxy(object): + """ + Maps read accesses to obj['key'] to obj.key + and hides all the rest of the obj + """ + def __init__(self, proxied_obj): + self.proxied_obj = proxied_obj + + def __getitem__(self, key): + try: + return getattr(self.proxied_obj, key) + except AttributeError: + raise KeyError("%r is not an attribute on %r" + % (key, self.proxied_obj)) -- cgit v1.2.3 From 20be9bb77dc9aa382e5555830ffcb199e0c43195 Mon Sep 17 00:00:00 2001 From: Sebastian Spaeth Date: Mon, 7 Jan 2013 13:52:14 +0100 Subject: Remove custom GMQuery class We provided a custom GMQuery class that offered a .sort() method for compatibility with the Mongo syntax. Now that we have settled for sqlalchemy which uses the order_by() method, we can safely remove this custom class and move a little closer to "pure" and native sqlalchemy usage. Signed-off-by: Sebastian Spaeth --- mediagoblin/db/base.py | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) (limited to 'mediagoblin/db/base.py') diff --git a/mediagoblin/db/base.py b/mediagoblin/db/base.py index 3530011e..699a503a 100644 --- a/mediagoblin/db/base.py +++ b/mediagoblin/db/base.py @@ -17,21 +17,8 @@ from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import scoped_session, sessionmaker, object_session -from sqlalchemy.orm.query import Query -def _get_query_model(query): - cols = query.column_descriptions - assert len(cols) == 1, "These functions work only on simple queries" - return cols[0]["type"] - - -class GMGQuery(Query): - def sort(self, key): - key_col = getattr(_get_query_model(self), key) - return self.order_by(key_col) - - -Session = scoped_session(sessionmaker(query_cls=GMGQuery)) +Session = scoped_session(sessionmaker()) class GMGTableBase(object): -- cgit v1.2.3