Removed whoosh hacks; 0.3 obviates them. #15

[zzz-pokedex.git] / pokedex / lookup.py

diff --git a/pokedex/lookup.py b/pokedex/lookup.py
index b50871b..37a50f3 100644 (file)
--- a/pokedex/lookup.py
+++ b/pokedex/lookup.py
@@ -1,11 +1,17 @@
 # encoding: utf8
 # encoding: utf8

+import os, os.path
+import pkg_resources

 import re
 
 from sqlalchemy.sql import func
 import whoosh
 import re
 
 from sqlalchemy.sql import func
 import whoosh

+import whoosh.filedb.filestore
+import whoosh.filedb.fileindex
+import whoosh.index

 from whoosh.qparser import QueryParser
 import whoosh.spelling
 
 from whoosh.qparser import QueryParser
 import whoosh.spelling
 

+from pokedex.db import connect

 import pokedex.db.tables as tables
 
 # Dictionary of table name => table class.
 import pokedex.db.tables as tables
 
 # Dictionary of table name => table class.


@@ -13,38 +19,77 @@ import pokedex.db.tables as tables
 # retrieve something from the index
 indexed_tables = {}
 for cls in [
 # retrieve something from the index
 indexed_tables = {}
 for cls in [

+        tables.Ability,
+        tables.Item,
+        tables.Move,

         tables.Pokemon,
         tables.Pokemon,

+        tables.Type,

     ]:
     indexed_tables[cls.__tablename__] = cls
 
 # Dictionary of extra keys to file types of objects under, e.g. Pokémon can
 # also be looked up purely by number
 extra_keys = {
     ]:
     indexed_tables[cls.__tablename__] = cls
 
 # Dictionary of extra keys to file types of objects under, e.g. Pokémon can
 # also be looked up purely by number
 extra_keys = {

+    tables.Move: [
+        lambda row: u"move %d" % row.id,
+    ],

     tables.Pokemon: [
         lambda row: unicode(row.id),
     ],
 }
 
     tables.Pokemon: [
         lambda row: unicode(row.id),
     ],
 }
 

-index_bits = {}
-def get_index(session):
-    """Returns (index, speller).
+def open_index(directory=None, session=None, recreate=False):
+    """Opens the whoosh index stored in the named directory and returns (index,
+    speller).  If the index doesn't already exist, it will be created.
+
+    `directory`
+        Directory containing the index.  Defaults to a location within the
+        `pokedex` egg directory.

 
 

-    Creates an index if one does not exist.
+    `session`
+        If the index needs to be created, this database session will be used.
+        Defaults to an attempt to connect to the default SQLite database
+        installed by `pokedex setup`.
+
+    `recreate`
+        If set to True, the whoosh index will be created even if it already
+        exists.

     """
 
     """
 

-    if index_bits:
-        return index_bits['index'], index_bits['speller']
+    # Defaults
+    if not directory:
+        directory = pkg_resources.resource_filename('pokedex',
+                                                    'data/whoosh_index')
+
+    if not session:
+        session = connect()

 
 

-    store = whoosh.store.RamStorage()
+    # Attempt to open or create the index
+    directory_exists = os.path.exists(directory)
+    if directory_exists and not recreate:
+        # Already exists; should be an index!
+        try:
+            index = whoosh.index.open_dir(directory, indexname='pokedex')
+            speller = whoosh.index.open_dir(directory, indexname='spelling')
+            return index, speller
+        except whoosh.index.EmptyIndexError as e:
+            # Apparently not a real index.  Fall out of the if and create it
+            pass
+
+    if not directory_exists:
+        os.mkdir(directory)
+
+
+    # Create index

     schema = whoosh.fields.Schema(
         name=whoosh.fields.ID(stored=True),
         table=whoosh.fields.STORED,
         row_id=whoosh.fields.STORED,
     schema = whoosh.fields.Schema(
         name=whoosh.fields.ID(stored=True),
         table=whoosh.fields.STORED,
         row_id=whoosh.fields.STORED,

-        language_id=whoosh.fields.STORED,
+        language=whoosh.fields.STORED,

     )
 
     )
 

-    # Construct a straight lookup index
-    index = whoosh.index.Index(store, schema=schema, create=True)
+    index = whoosh.index.create_in(directory, schema=schema,
+                                              indexname='pokedex')

     writer = index.writer()
 
     # Index every name in all our tables of interest
     writer = index.writer()
 
     # Index every name in all our tables of interest


@@ -69,7 +114,7 @@ def get_index(session):
 
             speller_entries.append(name)
 
 
             speller_entries.append(name)
 

-            for extra_key_func in extra_keys[cls]:
+            for extra_key_func in extra_keys.get(cls, []):

                 extra_key = extra_key_func(row)
                 writer.add_document(name=extra_key, **row_key)
 
                 extra_key = extra_key_func(row)
                 writer.add_document(name=extra_key, **row_key)
 


@@ -78,34 +123,13 @@ def get_index(session):
     # Construct and populate a spell-checker index.  Quicker to do it all
     # at once, as every call to add_* does a commit(), and those seem to be
     # expensive
     # Construct and populate a spell-checker index.  Quicker to do it all
     # at once, as every call to add_* does a commit(), and those seem to be
     # expensive

-    speller = whoosh.spelling.SpellChecker(index.storage)
-    # WARNING: HERE BE DRAGONS
-    # whoosh.spelling refuses to index things that don't look like words.
-    # Unfortunately, this doesn't work so well for Pokémon (Mr. Mime,
-    # Porygon-Z, etc.), and attempts to work around it lead to further
-    # complications.
-    # The below is copied from SpellChecker.add_scored_words without the check
-    # for isalpha().  XXX get whoosh patched to make this unnecessary!
-    writer = whoosh.writing.IndexWriter(speller.index())
-    for word in speller_entries:
-        fields = {"word": word, "score": 1}
-        for size in xrange(speller.mingram, speller.maxgram + 1):
-            nga = whoosh.analysis.NgramAnalyzer(size)
-            gramlist = [t.text for t in nga(word)]
-            if len(gramlist) > 0:
-                fields["start%s" % size] = gramlist[0]
-                fields["end%s" % size] = gramlist[-1]
-                fields["gram%s" % size] = " ".join(gramlist)
-        writer.add_document(**fields)
-    writer.commit()
-    # end copy-pasta
+    speller = whoosh.spelling.SpellChecker(index.storage, indexname='spelling')
+    speller.add_words(speller_entries)

 
 

-    index_bits['index'] = index
-    index_bits['speller'] = speller
-    index_bits['store'] = store
-    return index_bits['index'], index_bits['speller']
+    return index, speller

 
 

-def lookup(session, name, exact_only=False):
+
+def lookup(name, session=None, exact_only=False):

     """Attempts to find some sort of object, given a database session and name.
 
     Returns (objects, exact) where `objects` is a list of database objects, and
     """Attempts to find some sort of object, given a database session and name.
 
     Returns (objects, exact) where `objects` is a list of database objects, and


@@ -117,16 +141,32 @@ def lookup(session, name, exact_only=False):
 
     Currently recognizes:
     - Pokémon names: "Eevee"
 
     Currently recognizes:
     - Pokémon names: "Eevee"

+
+    `name`
+        Name of the thing to look for.
+
+    `session`
+        A database session to use for retrieving objects.  As with get_index,
+        if this is not provided, a connection to the default database will be
+        attempted.
+
+    `exact_only`
+        If True, only exact matches are returned.  If set to False (the
+        default), and the provided `name` doesn't match anything exactly,
+        spelling correction will be attempted.

     """
 
     """
 

-    exact = True
+    if not session:
+        session = connect()
+
+    index, speller = open_index()

 
 

-    index, speller = get_index(session)
+    exact = True

 
     # Look for exact name.  A Term object does an exact match, so we don't have
     # to worry about a query parser tripping on weird characters in the input
     searcher = index.searcher()
 
     # Look for exact name.  A Term object does an exact match, so we don't have
     # to worry about a query parser tripping on weird characters in the input
     searcher = index.searcher()

-    query = whoosh.query.Term('name', name)
+    query = whoosh.query.Term('name', name.lower())

     results = searcher.search(query)
 
     if not exact_only:
     results = searcher.search(query)
 
     if not exact_only: