from collections import namedtuple
import os, os.path
import pkg_resources
+import random
import re
+import shutil
from sqlalchemy.sql import func
import whoosh
import pokedex.db.tables as tables
from pokedex.roomaji import romanize
-__all__ = ['open_index', 'lookup']
+__all__ = ['open_index', 'lookup', 'random_lookup']
+
+INTERMEDIATE_LOOKUP_RESULTS = 25
+MAX_LOOKUP_RESULTS = 10
# Dictionary of table name => table class.
# Need the table name so we can get the class from the table name after we
# Defaults
if not directory:
directory = pkg_resources.resource_filename('pokedex',
- 'data/whoosh_index')
+ 'data/whoosh-index')
if not session:
session = connect()
# Apparently not a real index. Fall out of the if and create it
pass
+ # Delete and start over if we're going to bail anyway.
+ if directory_exists and recreate:
+ # Be safe and only delete if it looks like a whoosh index, i.e.,
+ # everything starts with _
+ if all(f[0] == '_' for f in os.listdir(directory)):
+ shutil.rmtree(directory)
+ directory_exists = False
+
if not directory_exists:
os.mkdir(directory)
row_id=unicode(row.id),
forme_name=u'XXX')
+ def add(name, language, score):
+ writer.add_document(name=name.lower(), display_name=name,
+ language=language,
+ **row_key)
+ speller_entries.append((name.lower(), score))
+
# 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))
+ add(name, None, 1)
# Pokemon also get other languages
for foreign_name in getattr(row, 'foreign_names', []):
# no point and it makes spell results confusing
continue
- writer.add_document(name=moonspeak.lower(),
- language=foreign_name.language.name,
- display_name=moonspeak,
- **row_key)
- speller_entries.append((moonspeak.lower(), 3))
+ add(moonspeak, foreign_name.language.name, 3)
# Add Roomaji too
if foreign_name.language.name == 'Japanese':
roomaji = romanize(foreign_name.name)
- writer.add_document(name=roomaji.lower(),
- language='Roomaji',
- display_name=roomaji,
- **row_key)
- speller_entries.append((roomaji.lower(), 8))
-
+ add(roomaji, u'Roomaji', 8)
writer.commit()
LookupResult = namedtuple('LookupResult',
['object', 'name', 'language', 'exact'])
+
+def _parse_table_name(name):
+ """Takes a singular table name, table name, or table object and returns the
+ table name.
+
+ Returns None for a bogus name.
+ """
+ if hasattr(name, '__tablename__'):
+ return getattr(name, '__tablename__')
+ elif name in indexed_tables:
+ return name
+ elif name + 's' in indexed_tables:
+ return name + 's'
+ else:
+ # Bogus. Be nice and return dummy
+ return None
+
+
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.
# 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):
+ # Random lookup
+ if name == 'random':
+ return random_lookup(indices=(index, speller),
+ session=session,
+ valid_types=valid_types)
+
+ # Do different things depending what the query looks like
+ # Note: 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 '*' in name or '?' in name:
+ exact_only = True
+ query = whoosh.query.Wildcard(u'name', name)
+ elif rx_is_number.match(name):
# Don't spell-check numbers!
exact_only = True
query = whoosh.query.Term(u'row_id', name)
### 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
-
+ table_name = _parse_table_name(valid_type)
type_terms.append(whoosh.query.Term(u'table', table_name))
if type_terms:
searcher.weighting = LanguageWeighting() # XXX kosher? docs say search()
# takes a weighting kw but it
# certainly does not
- results = searcher.search(query)
+ results = searcher.search(query, limit=INTERMEDIATE_LOOKUP_RESULTS)
# Look for some fuzzy matches if necessary
if not exact_only and not results:
exact = False
results = []
- for suggestion in speller.suggest(name, 25):
+ for suggestion in speller.suggest(name, INTERMEDIATE_LOOKUP_RESULTS):
query = whoosh.query.Term('name', suggestion)
results.extend(searcher.search(query))
# 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]
+ return objects[:MAX_LOOKUP_RESULTS]
+
+
+def random_lookup(valid_types=[], session=None, indices=None):
+ """Takes similar arguments as `lookup()`, but returns a random lookup
+ result from one of the provided `valid_types`.
+ """
+
+ tables = []
+ for valid_type in valid_types:
+ table_name = _parse_table_name(valid_type)
+ if table_name:
+ tables.append(indexed_tables[table_name])
+
+ if not tables:
+ tables = indexed_tables.values()
+
+ # Rather than create an array of many hundred items and pick randomly from
+ # it, just pick a number up to the total number of potential items, then
+ # pick randomly from that, and partition the whole range into chunks
+ total = 0
+ partitions = []
+ for table in tables:
+ count = session.query(table).count()
+ total += count
+ partitions.append((table, count))
+
+ n = random.randint(1, total)
+ while n > partitions[0][1]:
+ n -= partitions[0][1]
+ partitions.pop(0)
+
+ return lookup(unicode(n), valid_types=[ partitions[0][0] ],
+ indices=indices, session=session)