Changeset 176

Timestamp:

08/11/08 21:01:52 (11 months ago)

Author:

rgrp

Message:

[shakespeare/model][l]: refactor to use sqlalchemy.

Location:

trunk/shakespeare

Files:

• concordance.py (modified) (2 diffs)
• concordance_test.py (modified) (1 diff)
• config/environment.py (modified) (2 diffs)
• gutenberg.py (modified) (1 diff)
• gutenberg_test.py (modified) (1 diff)
• index.py (modified) (1 diff)
• moby.py (modified) (1 diff)
• model/dm.py (modified) (5 diffs)
• tests/functional/test_site.py (modified) (1 diff)
• tests/test_model.py (modified) (5 diffs)
• websetup.py (modified) (1 diff)

trunk/shakespeare/concordance.py

@@ -11 +11 @@
 import re
 
-import sqlobject
-
 import shakespeare.index
 import shakespeare.cache
@@ -21 +19 @@
     TODO: caching??
     """
-    sqlcc = shakespeare.model.Concordance
+    # sqlcc = shakespeare.model.Concordance
     sqlstat = shakespeare.model.Statistic
 

trunk/shakespeare/concordance_test.py

@@ -7 +7 @@
 import shakespeare.concordance
 
-class TestConcordancer:
+# Disable in preparation for removal
+class _TestConcordancer:
 
     inText = \

trunk/shakespeare/config/environment.py

@@ -1 +1 @@
 """Pylons environment configuration"""
 import os
+
+from sqlalchemy import engine_from_config
 
 from pylons import config
@@ -32 +34 @@
     # CONFIGURATION OPTIONS HERE (note: all config options will override
     # any Pylons config options)
+    config['pylons.g'].sa_engine = engine_from_config(config, 'sqlalchemy.')

trunk/shakespeare/gutenberg.py

@@ -319 +319 @@
                 name += '_f'
             
-            numExistingTexts = shakespeare.model.Material.select(
-                        shakespeare.model.Material.q.name==name).count()
+            numExistingTexts = shakespeare.model.Material.query.filter_by(
+                        name=name).count()
             if numExistingTexts > 0:
                 if self.verbose:

trunk/shakespeare/gutenberg_test.py

@@ -142 +142 @@
         shakespeare.model.Material.byName('hamlet_gut_f')
         assert 'Shakespeare, William' == text1.creator
-        alltexts = shakespeare.model.Material.select()
+        alltexts = shakespeare.model.Material.query.all()
         # do not delete because we may remove stuff that was there
         # though this may undermine tests

trunk/shakespeare/index.py

@@ -9 +9 @@
 
     def __init__(self):
-        self.all = shakespeare.model.Material.select(orderBy='name')
+        self.all = shakespeare.model.Material.query.order_by('name').all()
 
 

trunk/shakespeare/moby.py

@@ -124 +124 @@
             url = text[1]
             notes = 'Moby/Bosak Shakespeare, sourced from %s' % text[1]
-            numExistingTexts = shakespeare.model.Material.select(
-                        shakespeare.model.Material.q.name==name).count()
+            numExistingTexts = shakespeare.model.Material.query.filter_by(
+                        name=name).count()
             if numExistingTexts > 0:
                 if self.verbose:

trunk/shakespeare/model/dm.py

@@ -8 +8 @@
 text is a version.
 """
-import sqlobject
+from pylons import config
+from sqlalchemy import Column, MetaData, Table, types, ForeignKey
+from sqlalchemy import orm
+from sqlalchemy.orm import relation, backref
 
 # make sure config is registered
@@ -14 +17 @@
 shakespeare.conf()
 
-from pylons.database import PackageHub
-hub = PackageHub('shakespeare')
-sqlobject.sqlhub.processConnection = hub.getConnection()
+metadata = MetaData()
+Session = orm.scoped_session(orm.sessionmaker(
+    autoflush=True,
+    transactional=False,
+    bind=config['pylons.g'].sa_engine
+))
 
 import shakespeare
@@ -25 +31 @@
 import annotater.model
 
-# note we run this at bottom of module to auto create db tables on import
-def createdb():
-    Material.createTable(ifNotExists=True)
-    Concordance.createTable(ifNotExists=True)
-    Statistic.createTable(ifNotExists=True)
-    annotater.model.createdb()
+material_table = Table('material', metadata,
+    Column('id', types.Integer, primary_key=True),
+    Column('name', types.String(255)),
+    Column('title', types.String(255)),
+    Column('creator', types.String(255)),
+    Column('url', types.String(255)),
+    Column('notes', types.Text())
+    )
 
-def cleandb():
-    Statistic.dropTable(ifExists=True)
-    Concordance.dropTable(ifExists=True)
-    Material.dropTable(ifExists=True)
-    annotater.model.cleandb()
+# TODO: indices on word and occurences
+statistic_table = Table('statistic', metadata,
+    Column('id', types.Integer, primary_key=True),
+    Column('material_id', types.Integer, ForeignKey('material.id')),
+    Column('word', types.String(50)),
+    Column('occurrences', types.Integer, default=1),
+    )
 
-def rebuilddb():
-    cleandb()
-    createdb()
+
+from ConfigParser import SafeConfigParser
 
 
 
-from ConfigParser import SafeConfigParser
-class Material(sqlobject.SQLObject):
+class Material(object):
     """Material related to Shakespeare (usually text of works and ancillary
     matter such as introductions).
@@ -55 +63 @@
     TODO: mutiple creators ??
     """
+
+    # TODO: remove (just here for sqlobject bkwards compat)
+    @classmethod
+    def byName(self, name):
+        return self.query.filter_by(name=name).one()
     
-    name = sqlobject.StringCol(alternateID=True)
-    title = sqlobject.StringCol(default=None, length=255)
-    # creator rather than author to fit with dublin core
-    creator = sqlobject.StringCol(default=None, length=255)
-    url = sqlobject.StringCol(default=None, length=255)
-    notes = sqlobject.StringCol(default=None)
-
     def get_text(self, format=None):
         '''Get text (if any) associated with this material.
@@ -93 +99 @@
                 setattr(item, key, val)
 
+class Statistic(object):
+    pass
 
-class Concordance(sqlobject.SQLObject):
+# Map each domain model class to its corresponding relational table.
+mapper = Session.mapper
+mapper(Material, material_table)
+mapper(Statistic, statistic_table, properties={
+    'text':relation(Material, backref='statistics')
+    })
 
-    text = sqlobject.ForeignKey('Material')
-    word = sqlobject.StringCol(length=50)
-    line = sqlobject.IntCol()
-    char_index = sqlobject.IntCol()
-
-    word_index = sqlobject.DatabaseIndex('word')
-    text_index = sqlobject.DatabaseIndex('text')
-
-class Statistic(sqlobject.SQLObject):
-
-    text = sqlobject.ForeignKey('Material')
-    word = sqlobject.StringCol(length=50)
-    occurrences = sqlobject.IntCol(default=1)
-
-    word_index = sqlobject.DatabaseIndex('word')
-    text_index = sqlobject.DatabaseIndex('text')
-
-
-# auto create db tables on import
-createdb()
-

trunk/shakespeare/tests/functional/test_site.py

@@ -17 +17 @@
         assert 'guide to the features of the Open Shakespeare web' in res
 
-    def test_concordance(self):
+    def _test_concordance(self):
         url = url_for(controller='site', action='concordance')
         res = self.app.get(url)

trunk/shakespeare/tests/test_model.py

@@ -1 @@
-import sqlobject
-
 import shakespeare.model as model
 
@@ -12 +10 @@
         self.text = model.Material(name=self.name,
                 title=self.title, url=self.url)
+        model.Session.flush()
+        self.textid = self.text.id
+        model.Session.clear()
 
     @classmethod
     def teardown_class(self):
-        model.Material.delete(self.text.id)
+        text = model.Material.query.get(self.textid)
+        model.Session.delete(text)
+        model.Session.flush()
     
     def test1(self):
-        txtid = self.text.id
-        txt2 = model.Material.get(txtid)
+        txt2 = model.Material.query.get(self.textid)
         txt3 = model.Material.byName(self.name)
         assert self.text.id == txt2.id
@@ -29 +31 @@
         assert len(out) > 0
 
-    def test_get_text(self):
+    # TODO: set up fixtures before running this ...
+    def _test_get_text(self):
         text = model.Material.byName('phoenix_and_the_turtle_gut')
         out = text.get_text()
@@ -36 +39 @@
         assert out[:26] == 'THE PHOENIX AND THE TURTLE'
 
-
-class TestConcordance(object):
-
-    @classmethod
-    def setup_class(self):
-        self.name = 'test-123'
-        self.title = 'Hamlet'
-        self.text = model.Material(name=self.name, title=self.title)
-        word = 'jones'
-        line = 20
-        char_index = 500
-        self.cc1 = model.Concordance(text=self.text,
-                                         word=word,
-                                         line=line,
-                                         char_index=char_index)
-
-    @classmethod
-    def teardown_class(self):
-        model.Concordance.delete(self.cc1.id)
-        model.Material.delete(self.text.id)
-
-    def test1(self):
-        out1 = model.Concordance.get(self.cc1.id)
-        assert self.text == out1.text
 
 class TestStatistic:
@@ -75 +54 @@
                 occurrences=self.occurrences
                 )
+        model.Session.flush()
+        self.statid = self.cc1.id
+        model.Session.clear()
 
     @classmethod
     def teardown_class(self):
-        model.Statistic.delete(self.cc1.id)
-        model.Material.delete(self.text.id)
+        stat = model.Statistic.query.get(self.statid)
+        model.Session.delete(stat)
+        model.Session.delete(stat.text)
+        model.Session.flush()
+        model.Session.remove()
 
     def test1(self):
-        out1 = model.Statistic.get(self.cc1.id)
-        assert self.text == out1.text
+        out1 = model.Statistic.query.get(self.statid)
+        assert out1.text.name == self.name
         assert out1.occurrences == self.occurrences
 
     def test_select(self):
-        tresults  = model.Statistic.select(
-            sqlobject.AND(
-                model.Statistic.q.textID == self.text.id,
-                model.Statistic.q.word == self.word,
-                ))
+        tresults = model.Statistic.query.filter_by(text=self.text
+                ).filter_by(word=self.word)
         num = tresults.count()
         assert num == 1

trunk/shakespeare/websetup.py

@@ -13 +13 @@
     conf = appconfig('config:' + filename)
     load_environment(conf.global_conf, conf.local_conf)
+    from shakespeare import model
+    log.info('Creating tables')
+    model.metadata.create_all(bind=config['pylons.g'].sa_engine)
+    log.info('Creating tables: SUCCESS')
+