mirror of
https://github.com/veekun/pokedex.git
synced 2024-07-03 02:55:49 +00:00
11989d0db2
Wrote a little add() function to clean up the duplication of add_document(). Delete the index directory if it exists and we're being forced to recreate it.
323 lines
11 KiB
Python
323 lines
11 KiB
Python
# encoding: utf8
|
|
from collections import namedtuple
|
|
import os, os.path
|
|
import pkg_resources
|
|
import re
|
|
import shutil
|
|
|
|
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.scoring
|
|
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
|
|
indexed_tables = {}
|
|
for cls in [
|
|
tables.Ability,
|
|
tables.Item,
|
|
tables.Move,
|
|
tables.Pokemon,
|
|
tables.Type,
|
|
]:
|
|
indexed_tables[cls.__tablename__] = cls
|
|
|
|
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.
|
|
|
|
`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.
|
|
"""
|
|
|
|
# Defaults
|
|
if not directory:
|
|
directory = pkg_resources.resource_filename('pokedex',
|
|
'data/whoosh-index')
|
|
|
|
if not session:
|
|
session = connect()
|
|
|
|
# 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='MAIN')
|
|
spell_store = whoosh.filedb.filestore.FileStorage(directory)
|
|
speller = whoosh.spelling.SpellChecker(spell_store)
|
|
return index, speller
|
|
except whoosh.index.EmptyIndexError as e:
|
|
# 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)
|
|
|
|
|
|
### Create index
|
|
schema = whoosh.fields.Schema(
|
|
name=whoosh.fields.ID(stored=True),
|
|
table=whoosh.fields.ID(stored=True),
|
|
row_id=whoosh.fields.ID(stored=True),
|
|
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')
|
|
writer = index.writer()
|
|
|
|
# Index every name in all our tables of interest
|
|
# speller_entries becomes a list of (word, score) tuples; the score is 2
|
|
# for English names, 1.5 for Roomaji, and 1 for everything else. I think
|
|
# this biases the results in the direction most people expect, especially
|
|
# when e.g. German names are very similar to English names
|
|
speller_entries = []
|
|
for cls in indexed_tables.values():
|
|
q = session.query(cls)
|
|
|
|
for row in q.yield_per(5):
|
|
# 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')
|
|
|
|
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
|
|
add(name, None, 1)
|
|
|
|
# Pokemon also get other languages
|
|
for foreign_name in getattr(row, 'foreign_names', []):
|
|
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
|
|
|
|
add(moonspeak, foreign_name.language.name, 3)
|
|
|
|
# Add Roomaji too
|
|
if foreign_name.language.name == 'Japanese':
|
|
roomaji = romanize(foreign_name.name)
|
|
add(roomaji, u'Roomaji', 8)
|
|
|
|
writer.commit()
|
|
|
|
# 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)
|
|
speller.add_scored_words(speller_entries)
|
|
|
|
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'])
|
|
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`
|
|
is a database object, `name` is the name under which the object was found,
|
|
`language` is the name of the language in which the name was found, and
|
|
`exact` is True iff this was an exact match.
|
|
|
|
This function currently ONLY does fuzzy matching if there are no exact
|
|
matches.
|
|
|
|
Formes are not returned; "Shaymin" will return only grass Shaymin.
|
|
|
|
Recognizes:
|
|
- 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.
|
|
|
|
`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
|
|
attempted.
|
|
|
|
`indices`
|
|
Tuple of index, speller as returned from `open_index()`. Defaults to
|
|
a call to `open_index()`.
|
|
|
|
`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.
|
|
"""
|
|
|
|
if not session:
|
|
session = connect()
|
|
|
|
if indices:
|
|
index, speller = indices
|
|
else:
|
|
index, speller = open_index()
|
|
|
|
name = unicode(input).lower()
|
|
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
|
|
|
|
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.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
|
|
if not exact_only and not results:
|
|
exact = False
|
|
results = []
|
|
|
|
for suggestion in speller.suggest(name, 25):
|
|
query = whoosh.query.Term('name', suggestion)
|
|
results.extend(searcher.search(query))
|
|
|
|
### Convert results to db objects
|
|
objects = []
|
|
seen = {}
|
|
for result in results:
|
|
# Skip dupe results
|
|
seen_key = result['table'], result['row_id']
|
|
if seen_key in seen:
|
|
continue
|
|
seen[seen_key] = True
|
|
|
|
cls = indexed_tables[result['table']]
|
|
obj = session.query(cls).get(result['row_id'])
|
|
|
|
objects.append(LookupResult(object=obj,
|
|
name=result['display_name'],
|
|
language=result['language'],
|
|
exact=exact))
|
|
|
|
# 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]
|