]> git.decadent.org.uk Git - dak.git/blobdiff - daklib/dbconn.py
Attach commit_or_flush to session object to call either .commit() or .flush()
[dak.git] / daklib / dbconn.py
index 1f8b32b8502a83ed0a173db30662715b7429a66b..ca90ba8882bedaa6dc316d94efd44fb2c09086ae 100755 (executable)
@@ -44,6 +44,7 @@ from sqlalchemy.orm import sessionmaker, mapper, relation
 
 # Don't remove this, we re-export the exceptions to scripts which import us
 from sqlalchemy.exc import *
+from sqlalchemy.orm.exc import NoResultFound
 
 # Only import Config until Queue stuff is changed to store its config
 # in the database
@@ -58,21 +59,45 @@ __all__ = ['IntegrityError', 'SQLAlchemyError']
 ################################################################################
 
 def session_wrapper(fn):
+    """
+    Wrapper around common ".., session=None):" handling. If the wrapped
+    function is called without passing 'session', we create a local one
+    and destroy it when the function ends.
+
+    Also attaches a commit_or_flush method to the session; if we created a
+    local session, this is a synonym for session.commit(), otherwise it is a
+    synonym for session.flush().
+    """
+
     def wrapped(*args, **kwargs):
         private_transaction = False
-        session = kwargs.get('session')
 
-        # No session specified as last argument or in kwargs, create one.
-        if session is None and len(args) == len(getargspec(fn)[0]) - 1:
-            private_transaction = True
-            kwargs['session'] = DBConn().session()
+        # Find the session object
+        try:
+            session = kwargs['session']
+        except KeyError:
+            if len(args) <= len(getargspec(fn)[0]) - 1:
+                # No session specified as last argument or in kwargs
+                private_transaction = True
+                session = kwargs['session'] = DBConn().session()
+            else:
+                # Session is last argument in args
+                session = args[-1]
+
+        if private_transaction:
+            session.commit_or_flush = session.commit
+        else:
+            session.commit_or_flush = session.flush
 
         try:
             return fn(*args, **kwargs)
         finally:
             if private_transaction:
                 # We created a session; close it.
-                kwargs['session'].close()
+                session.close()
+
+    wrapped.__doc__ = fn.__doc__
+    wrapped.func_name = fn.func_name
 
     return wrapped
 
@@ -117,12 +142,10 @@ def get_architecture(architecture, session=None):
 
     q = session.query(Architecture).filter_by(arch_string=architecture)
 
-    if q.count() == 0:
-        ret = None
-    else:
-        ret = q.one()
-
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_architecture')
 
@@ -166,7 +189,7 @@ __all__.append('Archive')
 @session_wrapper
 def get_archive(archive, session=None):
     """
-    returns database id for given c{archive}.
+    returns database id for given C{archive}.
 
     @type archive: string
     @param archive: the name of the arhive
@@ -183,12 +206,10 @@ def get_archive(archive, session=None):
 
     q = session.query(Archive).filter_by(archive_name=archive)
 
-    if q.count() == 0:
-        ret = None
-    else:
-        ret = q.one()
-
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_archive')
 
@@ -226,9 +247,7 @@ def get_suites_binary_in(package, session=None):
     @return: list of Suite objects for the given package
     """
 
-    ret = session.query(Suite).join(BinAssociation).join(DBBinary).filter_by(package=package).all()
-
-    return ret
+    return session.query(Suite).join(BinAssociation).join(DBBinary).filter_by(package=package).all()
 
 __all__.append('get_suites_binary_in')
 
@@ -250,12 +269,10 @@ def get_binary_from_id(id, session=None):
 
     q = session.query(DBBinary).filter_by(binary_id=id)
 
-    if q.count() == 0:
-        ret = None
-    else:
-        ret = q.one()
-
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_binary_from_id')
 
@@ -313,9 +330,7 @@ def get_binaries_from_source_id(source_id, session=None):
     @return: list of DBBinary objects for the given name (may be empty)
     """
 
-    ret = session.query(DBBinary).filter_by(source_id=source_id).all()
-
-    return ret
+    return session.query(DBBinary).filter_by(source_id=source_id).all()
 
 __all__.append('get_binaries_from_source_id')
 
@@ -335,9 +350,7 @@ def get_binary_from_name_suite(package, suitename, session=None):
                AND su.suite_name=:suitename
           ORDER BY b.version DESC"""
 
-    ret = session.execute(sql, {'package': package, 'suitename': suitename})
-
-    return ret
+    return session.execute(sql, {'package': package, 'suitename': suitename})
 
 __all__.append('get_binary_from_name_suite')
 
@@ -354,9 +367,7 @@ def get_binary_components(package, suitename, arch, session=None):
 
     vals = {'package': package, 'suitename': suitename, 'arch': arch}
 
-    ret = session.execute(query, vals)
-
-    return ret
+    return session.execute(query, vals)
 
 __all__.append('get_binary_components')
 
@@ -400,12 +411,10 @@ def get_component(component, session=None):
 
     q = session.query(Component).filter_by(component_name=component)
 
-    if q.count() == 0:
-        ret = None
-    else:
-        ret = q.one()
-
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_component')
 
@@ -453,7 +462,10 @@ def get_or_set_contents_file_id(filename, session=None):
         privatetrans = True
 
     q = session.query(ContentFilename).filter_by(filename=filename)
-    if q.count() < 1:
+
+    try:
+        ret = q.one().cafilename_id
+    except NoResultFound:
         cf = ContentFilename()
         cf.filename = filename
         session.add(cf)
@@ -462,8 +474,6 @@ def get_or_set_contents_file_id(filename, session=None):
         else:
             session.flush()
         ret = cf.cafilename_id
-    else:
-        ret = q.one().cafilename_id
 
     if privatetrans:
         session.close()
@@ -519,9 +529,7 @@ def get_contents(suite, overridetype, section=None, session=None):
 
     contents_q += " ORDER BY fn"
 
-    ret = session.execute(contents_q, vals)
-
-    return ret
+    return session.execute(contents_q, vals)
 
 __all__.append('get_contents')
 
@@ -558,7 +566,10 @@ def get_or_set_contents_path_id(filepath, session=None):
         privatetrans = True
 
     q = session.query(ContentFilepath).filter_by(filepath=filepath)
-    if q.count() < 1:
+
+    try:
+        ret = q.one().cafilepath_id
+    except NoResultFound:
         cf = ContentFilepath()
         cf.filepath = filepath
         session.add(cf)
@@ -567,8 +578,6 @@ def get_or_set_contents_path_id(filepath, session=None):
         else:
             session.flush()
         ret = cf.cafilepath_id
-    else:
-        ret = q.one().cafilepath_id
 
     if privatetrans:
         session.close()
@@ -691,9 +700,7 @@ def get_dscfiles(dscfile_id=None, source_id=None, poolfile_id=None, session=None
     if poolfile_id is not None:
         q = q.filter_by(poolfile_id=poolfile_id)
 
-    ret = q.all()
-
-    return ret
+    return q.all()
 
 __all__.append('get_dscfiles')
 
@@ -771,12 +778,10 @@ def get_poolfile_by_id(file_id, session=None):
 
     q = session.query(PoolFile).filter_by(file_id=file_id)
 
-    if q.count() > 0:
-        ret = q.one()
-    else:
-        ret = None
-
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_poolfile_by_id')
 
@@ -802,9 +807,7 @@ def get_poolfile_by_name(filename, location_id=None, session=None):
     if location_id is not None:
         q = q.join(Location).filter_by(location_id=location_id)
 
-    ret = q.all()
-
-    return ret
+    return q.all()
 
 __all__.append('get_poolfile_by_name')
 
@@ -823,9 +826,7 @@ def get_poolfile_like_name(filename, session=None):
     # TODO: There must be a way of properly using bind parameters with %FOO%
     q = session.query(PoolFile).filter(PoolFile.filename.like('%%%s%%' % filename))
 
-    ret = q.all()
-
-    return ret
+    return q.all()
 
 __all__.append('get_poolfile_like_name')
 
@@ -864,7 +865,10 @@ def get_or_set_fingerprint(fpr, session=None):
         privatetrans = True
 
     q = session.query(Fingerprint).filter_by(fingerprint=fpr)
-    if q.count() < 1:
+
+    try:
+        ret = q.one()
+    except NoResultFound:
         fingerprint = Fingerprint()
         fingerprint.fingerprint = fpr
         session.add(fingerprint)
@@ -873,8 +877,6 @@ def get_or_set_fingerprint(fpr, session=None):
         else:
             session.flush()
         ret = fingerprint
-    else:
-        ret = q.one()
 
     if privatetrans:
         session.close()
@@ -968,12 +970,10 @@ def get_location(location, component=None, archive=None, session=None):
     if component is not None:
         q = q.join(Component).filter_by(component_name=component)
 
-    if q.count() < 1:
-        ret = None
-    else:
-        ret = q.one()
-
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_location')
 
@@ -1018,7 +1018,9 @@ def get_or_set_maintainer(name, session=None):
         privatetrans = True
 
     q = session.query(Maintainer).filter_by(name=name)
-    if q.count() < 1:
+    try:
+        ret = q.one()
+    except NoResultFound:
         maintainer = Maintainer()
         maintainer.name = name
         session.add(maintainer)
@@ -1027,8 +1029,6 @@ def get_or_set_maintainer(name, session=None):
         else:
             session.flush()
         ret = maintainer
-    else:
-        ret = q.one()
 
     if privatetrans:
         session.close()
@@ -1096,9 +1096,7 @@ def has_new_comment(package, version, session=None):
     q = q.filter_by(package=package)
     q = q.filter_by(version=version)
 
-    ret = q.count() > 0
-
-    return ret
+    return bool(q.count() > 0)
 
 __all__.append('has_new_comment')
 
@@ -1130,9 +1128,7 @@ def get_new_comments(package=None, version=None, comment_id=None, session=None):
     if version is not None: q = q.filter_by(version=version)
     if comment_id is not None: q = q.filter_by(comment_id=comment_id)
 
-    ret = q.all()
-
-    return ret
+    return q.all()
 
 __all__.append('get_new_comments')
 
@@ -1190,9 +1186,7 @@ def get_override(package, suite=None, component=None, overridetype=None, session
         if not isinstance(overridetype, list): overridetype = [overridetype]
         q = q.join(OverrideType).filter(OverrideType.overridetype.in_(overridetype))
 
-    ret = q.all()
-
-    return ret
+    return q.all()
 
 __all__.append('get_override')
 
@@ -1226,12 +1220,10 @@ def get_override_type(override_type, session=None):
 
     q = session.query(OverrideType).filter_by(overridetype=override_type)
 
-    if q.count() == 0:
-        ret = None
-    else:
-        ret = q.one()
-
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_override_type')
 
@@ -1364,12 +1356,10 @@ def get_priority(priority, session=None):
 
     q = session.query(Priority).filter_by(priority=priority)
 
-    if q.count() == 0:
-        ret = None
-    else:
-        ret = q.one()
-
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_priority')
 
@@ -1460,6 +1450,7 @@ class Queue(object):
                 # TODO: Move into database as above
                 if conf.FindB("Dinstall::SecurityQueueBuild"):
                     # Copy it since the original won't be readable by www-data
+                    import utils
                     utils.copy(src, dest)
                 else:
                     # Create a symlink to it
@@ -1535,12 +1526,11 @@ def get_queue(queuename, session=None):
     """
 
     q = session.query(Queue).filter_by(queue_name=queuename)
-    if q.count() == 0:
-        ret = None
-    else:
-        ret = q.one()
 
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_queue')
 
@@ -1580,12 +1570,10 @@ def get_queue_build(filename, suite, session=None):
         q = session.query(QueueBuild).filter_by(filename=filename)
         q = q.join(Suite).filter_by(suite_name=suite)
 
-    if q.count() == 0:
-        ret = None
-    else:
-        ret = q.one()
-
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_queue_build')
 
@@ -1629,12 +1617,11 @@ def get_section(section, session=None):
     """
 
     q = session.query(Section).filter_by(section=section)
-    if q.count() == 0:
-        ret = None
-    else:
-        ret = q.one()
 
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_section')
 
@@ -1751,9 +1738,7 @@ def get_suites_source_in(source, session=None):
     @return: list of Suite objects for the given source
     """
 
-    ret = session.query(Suite).join(SrcAssociation).join(DBSource).filter_by(source=source).all()
-
-    return ret
+    return session.query(Suite).join(SrcAssociation).join(DBSource).filter_by(source=source).all()
 
 __all__.append('get_suites_source_in')
 
@@ -1788,9 +1773,7 @@ def get_sources_from_name(source, version=None, dm_upload_allowed=None, session=
     if dm_upload_allowed is not None:
         q = q.filter_by(dm_upload_allowed=dm_upload_allowed)
 
-    ret = q.all()
-
-    return ret
+    return q.all()
 
 __all__.append('get_sources_from_name')
 
@@ -1817,13 +1800,10 @@ def get_source_in_suite(source, suite, session=None):
     q = q.join('source').filter_by(source=source)
     q = q.join('suite').filter_by(suite_name=suite)
 
-    if q.count() == 0:
-        ret =  None
-    else:
-        # ???: Maybe we should just return the SrcAssociation object instead
-        ret = q.one().source
-
-    return ret
+    try:
+        return q.one().source
+    except NoResultFound:
+        return None
 
 __all__.append('get_source_in_suite')
 
@@ -1925,12 +1905,10 @@ def get_suite_architecture(suite, architecture, session=None):
     q = q.join(Architecture).filter_by(arch_string=architecture)
     q = q.join(Suite).filter_by(suite_name=suite)
 
-    if q.count() == 0:
-        ret = None
-    else:
-        ret = q.one()
-
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_suite_architecture')
 
@@ -1947,17 +1925,15 @@ def get_suite(suite, session=None):
     generated if not supplied)
 
     @rtype: Suite
-    @return: Suite object for the requested suite name (None if not presenT)
+    @return: Suite object for the requested suite name (None if not present)
     """
 
     q = session.query(Suite).filter_by(suite_name=suite)
 
-    if q.count() == 0:
-        ret = None
-    else:
-        ret = q.one()
-
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_suite')
 
@@ -2008,9 +1984,7 @@ def get_suite_architectures(suite, skipsrc=False, skipall=False, session=None):
 
     q = q.order_by('arch_string')
 
-    ret = q.all()
-
-    return ret
+    return q.all()
 
 __all__.append('get_suite_architectures')
 
@@ -2091,7 +2065,9 @@ def get_or_set_uid(uidname, session=None):
 
     q = session.query(Uid).filter_by(uid=uidname)
 
-    if q.count() < 1:
+    try:
+        ret = q.one()
+    except NoResultFound:
         uid = Uid()
         uid.uid = uidname
         session.add(uid)
@@ -2100,8 +2076,6 @@ def get_or_set_uid(uidname, session=None):
         else:
             session.flush()
         ret = uid
-    else:
-        ret = q.one()
 
     if privatetrans:
         session.close()
@@ -2115,12 +2089,10 @@ def get_uid_from_fingerprint(fpr, session=None):
     q = session.query(Uid)
     q = q.join(Fingerprint).filter_by(fingerprint=fpr)
 
-    if q.count() != 1:
-        ret = None
-    else:
-        ret = q.one()
-
-    return ret
+    try:
+        return q.one()
+    except NoResultFound:
+        return None
 
 __all__.append('get_uid_from_fingerprint')