Added lookup tests. #15

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

diff --git a/pokedex/lookup.py b/pokedex/lookup.py
index 2653b9a..51bbc4e 100644 (file)
--- a/pokedex/lookup.py
+++ b/pokedex/lookup.py
@@ -10,12 +10,15 @@ import whoosh.filedb.filestore
 import whoosh.filedb.fileindex
 import whoosh.index
 from whoosh.qparser import QueryParser
 import whoosh.filedb.fileindex
 import whoosh.index
 from whoosh.qparser import QueryParser

+import whoosh.scoring

 import whoosh.spelling
 
 from pokedex.db import connect
 import pokedex.db.tables as tables
 from pokedex.roomaji import romanize
 
 import whoosh.spelling
 
 from pokedex.db import connect
 import pokedex.db.tables as tables
 from pokedex.roomaji import romanize
 

+__all__ = ['open_index', 'lookup']
+

 # Dictionary of table name => table class.
 # Need the table name so we can get the class from the table name after we
 # retrieve something from the index
 # Dictionary of table name => table class.
 # Need the table name so we can get the class from the table name after we
 # retrieve something from the index


@@ -29,17 +32,6 @@ for cls in [
     ]:
     indexed_tables[cls.__tablename__] = cls
 
     ]:
     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),
-    ],
-}
-

 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.
 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.


@@ -83,12 +75,14 @@ def open_index(directory=None, session=None, recreate=False):
         os.mkdir(directory)
 
 
         os.mkdir(directory)
 
 

-    # Create index
+    ### Create index

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

-        table=whoosh.fields.STORED,
-        row_id=whoosh.fields.STORED,
+        table=whoosh.fields.ID(stored=True),
+        row_id=whoosh.fields.ID(stored=True),

         language=whoosh.fields.STORED,
         language=whoosh.fields.STORED,

+        display_name=whoosh.fields.STORED,  # non-lowercased name
+        forme_name=whoosh.fields.ID,

     )
 
     index = whoosh.index.create_in(directory, schema=schema, indexname='MAIN')
     )
 
     index = whoosh.index.create_in(directory, schema=schema, indexname='MAIN')


@@ -103,40 +97,45 @@ def open_index(directory=None, session=None, recreate=False):
     for cls in indexed_tables.values():
         q = session.query(cls)
 
     for cls in indexed_tables.values():
         q = session.query(cls)
 

-        # Only index base Pokémon formes
-        if hasattr(cls, 'forme_base_pokemon_id'):
-            q = q.filter_by(forme_base_pokemon_id=None)
-

         for row in q.yield_per(5):
         for row in q.yield_per(5):

-            row_key = dict(table=cls.__tablename__, row_id=row.id)
-
-            name = row.name.lower()
-            writer.add_document(name=name, **row_key)
-            speller_entries.append((name, 1))
-
-            for extra_key_func in extra_keys.get(cls, []):
-                extra_key = extra_key_func(row)
-                writer.add_document(name=extra_key, **row_key)
+            # XXX need to give forme_name a dummy value because I can't search
+            # for explicitly empty fields.  boo.
+            row_key = dict(table=unicode(cls.__tablename__),
+                           row_id=unicode(row.id),
+                           forme_name=u'XXX')
+
+            # If this is a form, mark it as such
+            if getattr(row, 'forme_base_pokemon_id', None):
+                row_key['forme_name'] = row.forme_name
+
+            name = row.name
+            writer.add_document(name=name.lower(),
+                                display_name=name,
+                                **row_key)
+            speller_entries.append((name.lower(), 1))

 
             # Pokemon also get other languages
             for foreign_name in getattr(row, 'foreign_names', []):
 
             # Pokemon also get other languages
             for foreign_name in getattr(row, 'foreign_names', []):

-                moonspeak = foreign_name.name.lower()
+                moonspeak = foreign_name.name

                 if name == moonspeak:
                     # Don't add the English name again as a different language;
                     # no point and it makes spell results confusing
                     continue
 
                 if name == moonspeak:
                     # Don't add the English name again as a different language;
                     # no point and it makes spell results confusing
                     continue
 

-                writer.add_document(name=moonspeak,
+                writer.add_document(name=moonspeak.lower(),

                                     language=foreign_name.language.name,
                                     language=foreign_name.language.name,

+                                    display_name=moonspeak,

                                     **row_key)
                                     **row_key)

-                speller_entries.append((moonspeak, 3))
+                speller_entries.append((moonspeak.lower(), 3))

 
                 # Add Roomaji too
                 if foreign_name.language.name == 'Japanese':
 
                 # Add Roomaji too
                 if foreign_name.language.name == 'Japanese':

-                    roomaji = romanize(foreign_name.name).lower()
-                    writer.add_document(name=roomaji, language='Roomaji',
+                    roomaji = romanize(foreign_name.name)
+                    writer.add_document(name=roomaji.lower(),
+                                        language='Roomaji',
+                                        display_name=roomaji,

                                         **row_key)
                                         **row_key)

-                    speller_entries.append((roomaji, 8))
+                    speller_entries.append((roomaji.lower(), 8))

 
 
     writer.commit()
 
 
     writer.commit()


@@ -150,9 +149,28 @@ def open_index(directory=None, session=None, recreate=False):
     return index, speller
 
 
     return index, speller
 
 

+class LanguageWeighting(whoosh.scoring.Weighting):
+    """A scoring class that forces otherwise-equal English results to come
+    before foreign results.
+    """
+
+    def score(self, searcher, fieldnum, text, docnum, weight, QTF=1):
+        doc = searcher.stored_fields(docnum)
+        if doc['language'] == None:
+            # English (well, "default"); leave it at 1
+            return weight
+        elif doc['language'] == u'Roomaji':
+            # Give Roomaji a bit of a boost, as it's most likely to be searched
+            return weight * 0.95
+        else:
+            # Everything else can drop down the totem pole
+            return weight * 0.9
+
+rx_is_number = re.compile('^\d+$')
+

 LookupResult = namedtuple('LookupResult',
                           ['object', 'name', 'language', 'exact'])
 LookupResult = namedtuple('LookupResult',
                           ['object', 'name', 'language', 'exact'])

-def lookup(name, session=None, indices=None, exact_only=False):
+def lookup(input, valid_types=[], session=None, indices=None, exact_only=False):

     """Attempts to find some sort of object, given a database session and name.
 
     Returns a list of named (object, name, language, exact) tuples.  `object`
     """Attempts to find some sort of object, given a database session and name.
 
     Returns a list of named (object, name, language, exact) tuples.  `object`


@@ -166,11 +184,25 @@ def lookup(name, session=None, indices=None, exact_only=False):
     Formes are not returned; "Shaymin" will return only grass Shaymin.
 
     Recognizes:
     Formes are not returned; "Shaymin" will return only grass Shaymin.
 
     Recognizes:

-    - Pokémon names: "Eevee"
-
-    `name`
+    - Names: "Eevee", "Surf", "Run Away", "Payapa Berry", etc.
+    - Foreign names: "Iibui", "Eivui"
+    - Fuzzy names in whatever language: "Evee", "Ibui"
+    - IDs: "133", "192", "250"
+    Also:
+    - Type restrictions.  "type:psychic" will only return the type.  This is
+      how to make ID lookup useful.  Multiple type specs can be entered with
+      commas, as "move,item:1".  If `valid_types` are provided, any type prefix
+      will be ignored.
+    - Alternate formes can be specified merely like "wash rotom".
+
+    `input`

         Name of the thing to look for.
 
         Name of the thing to look for.
 

+    `valid_types`
+        A list of table objects or names, e.g., `['pokemon', 'moves']`.  If
+        this is provided, only results in one of the given tables will be
+        returned.
+

     `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
     `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


@@ -194,14 +226,62 @@ def lookup(name, session=None, indices=None, exact_only=False):
     else:
         index, speller = open_index()
 
     else:
         index, speller = open_index()
 

-    name = unicode(name)
-
+    name = unicode(input).lower()

     exact = True
     exact = True

+    form = None
+
+    # Remove any type prefix (pokemon:133) before constructing a query
+    if ':' in name:
+        prefix_chunk, name = name.split(':', 2)
+        prefixes = prefix_chunk.split(',')
+        if not valid_types:
+            # Only use types from the query string if none were explicitly
+            # provided
+            valid_types = prefixes
+
+    # If the input provided is a number, match it as an id.  Otherwise, name.
+    # Term objects do an exact match, so we don't have to worry about a query
+    # parser tripping on weird characters in the input
+    if rx_is_number.match(name):
+        # Don't spell-check numbers!
+        exact_only = True
+        query = whoosh.query.Term(u'row_id', name)
+    else:
+        # Not an integer
+        query = whoosh.query.Term(u'name', name) \
+              & whoosh.query.Term(u'forme_name', u'XXX')
+
+        # If there's a space in the input, this might be a form
+        if ' ' in name:
+            form, formless_name = name.split(' ', 2)
+            form_query = whoosh.query.Term(u'name', formless_name) \
+                       & whoosh.query.Term(u'forme_name', form)
+            query = query | form_query
+
+    ### Filter by type of object
+    type_terms = []
+    for valid_type in valid_types:
+        if hasattr(valid_type, '__tablename__'):
+            table_name = getattr(valid_type, '__tablename__')
+        elif valid_type in indexed_tables:
+            table_name = valid_type
+        elif valid_type + 's' in indexed_tables:
+            table_name = valid_type + 's'
+        else:
+            # Bogus.  Be nice and ignore it
+            continue

 
 

-    # 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
+        type_terms.append(whoosh.query.Term(u'table', table_name))
+
+    if type_terms:
+        query = query & whoosh.query.Or(type_terms)
+
+
+    ### Actual searching

     searcher = index.searcher()
     searcher = index.searcher()

-    query = whoosh.query.Term('name', name.lower())
+    searcher.weighting = LanguageWeighting()  # XXX kosher?  docs say search()
+                                              # takes a weighting kw but it
+                                              # certainly does not

     results = searcher.search(query)
 
     # Look for some fuzzy matches if necessary
     results = searcher.search(query)
 
     # Look for some fuzzy matches if necessary


@@ -209,7 +289,7 @@ def lookup(name, session=None, indices=None, exact_only=False):
         exact = False
         results = []
 
         exact = False
         results = []
 

-        for suggestion in speller.suggest(name, 10):
+        for suggestion in speller.suggest(name, 25):

             query = whoosh.query.Term('name', suggestion)
             results.extend(searcher.search(query))
 
             query = whoosh.query.Term('name', suggestion)
             results.extend(searcher.search(query))
 


@@ -218,12 +298,6 @@ def lookup(name, session=None, indices=None, exact_only=False):
     seen = {}
     for result in results:
         # Skip dupe results
     seen = {}
     for result in results:
         # Skip dupe results

-        # Note!  The speller prefers English names, but the query does not.  So
-        # "latias" comes over "ratiasu".  "latias" matches only the English
-        # row, comes out first, and all is well.
-        # However!  The speller could then return "foo" which happens to be the
-        # name for two different things in different languages, and the
-        # non-English one could appear preferred.  This is not very likely.

         seen_key = result['table'], result['row_id']
         if seen_key in seen:
             continue
         seen_key = result['table'], result['row_id']
         if seen_key in seen:
             continue


@@ -231,9 +305,15 @@ def lookup(name, session=None, indices=None, exact_only=False):
 
         cls = indexed_tables[result['table']]
         obj = session.query(cls).get(result['row_id'])
 
         cls = indexed_tables[result['table']]
         obj = session.query(cls).get(result['row_id'])

+

         objects.append(LookupResult(object=obj,
         objects.append(LookupResult(object=obj,

-                                    name=result['name'],
+                                    name=result['display_name'],

                                     language=result['language'],
                                     exact=exact))
 
                                     language=result['language'],
                                     exact=exact))
 

-    return objects[:5]
+    # Only return up to 10 matches; beyond that, something is wrong.
+    # We strip out duplicate entries above, so it's remotely possible that we
+    # should have more than 10 here and lost a few.  The speller returns 25 to
+    # give us some padding, and should avoid that problem.  Not a big deal if
+    # we lose the 25th-most-likely match anyway.
+    return objects[:10]