rx_is_number = re.compile('^\d+$')
LookupResult = namedtuple('LookupResult',
- ['object', 'name', 'language', 'iso3166', 'exact'])
+ ['object', 'indexed_name', 'name', 'language', 'iso3166', 'exact'])
class LanguageWeighting(whoosh.scoring.Weighting):
"""A scoring class that forces otherwise-equal English results to come
for cls in (
tables.Ability,
tables.Item,
+ tables.Location,
tables.Move,
+ tables.Nature,
tables.Pokemon,
tables.Type,
)
language=whoosh.fields.STORED,
iso3166=whoosh.fields.STORED,
display_name=whoosh.fields.STORED, # non-lowercased name
- forme_name=whoosh.fields.ID,
)
self.index = whoosh.index.create_in(directory, schema=schema,
# especially when e.g. German names are very similar to English names
speller_entries = []
for cls in self.indexed_tables.values():
- q = session.query(cls)
+ q = self.session.query(cls)
for row in q.yield_per(5):
- # 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'__empty__')
+ row_id=unicode(row.id))
def add(name, language, iso3166, score):
normalized_name = self.normalize_name(name)
+
writer.add_document(
name=normalized_name, display_name=name,
language=language, iso3166=iso3166,
**row_key
)
+
speller_entries.append((normalized_name, 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, u'us', 1)
+ # Add the basic English name to the index
+ if cls == tables.Pokemon:
+ # Pokémon need their form name added
+ # XXX kinda kludgy
+ add(row.full_name, None, u'us', 1)
+
+ # If this is a default form, ALSO add the unadorned name,
+ # so 'Deoxys' alone will still do the right thing
+ if row.forme_name and not row.forme_base_pokemon_id:
+ add(row.name, None, u'us', 1)
+ else:
+ add(row.name, None, u'us', 1)
- # Pokemon also get other languages
+ # Some things also have other languages' names
+ # XXX other language form names..?
for foreign_name in getattr(row, 'foreign_names', []):
moonspeak = foreign_name.name
- if name == moonspeak:
+ if row.name == moonspeak:
# Don't add the English name again as a different
# language; no point and it makes spell results
# confusing
return name
+ def _apply_valid_types(self, name, valid_types):
+ """Combines the enforced `valid_types` with any from the search string
+ itself and updates the query.
+
+ For example, a name of 'a,b:foo' and valid_types of b,c will search for
+ only `b`s named "foo".
+
+ Returns `(name, merged_valid_types, term)`, where `name` has had any type
+ prefix stripped, `merged_valid_types` combines the original
+ `valid_types` with the type prefix, and `term` is a query term for
+ limited to just the allowed types. If there are no type restrictions
+ at all, `term` will be None.
+ """
+
+ # Remove any type prefix (pokemon:133) first
+ user_valid_types = []
+ if ':' in name:
+ prefix_chunk, name = name.split(':', 1)
+ name = name.strip()
+
+ prefixes = prefix_chunk.split(',')
+ user_valid_types = [_.strip() for _ in prefixes]
+
+ # Merge the valid types together. Only types that appear in BOTH lists
+ # may be used.
+ # As a special case, if the user asked for types that are explicitly
+ # forbidden, completely ignore what the user requested
+ combined_valid_types = []
+ if user_valid_types and valid_types:
+ combined_valid_types = list(
+ set(user_valid_types) & set(combined_valid_types)
+ )
+
+ if not combined_valid_types:
+ # No overlap! Just use the enforced ones
+ combined_valid_types = valid_types
+ else:
+ # One list or the other was blank, so just use the one that isn't
+ combined_valid_types = valid_types + user_valid_types
+
+ if not combined_valid_types:
+ # No restrictions
+ return name, [], None
+
+ # Construct the term
+ type_terms = []
+ final_valid_types = []
+ for valid_type in combined_valid_types:
+ table_name = self._parse_table_name(valid_type)
+
+ # Quietly ignore bogus valid_types; more likely to DTRT
+ if table_name:
+ final_valid_types.append(valid_type)
+ type_terms.append(whoosh.query.Term(u'table', table_name))
+
+ return name, final_valid_types, whoosh.query.Or(type_terms)
+
+
def _parse_table_name(self, name):
"""Takes a singular table name, table name, or table object and returns
the table name.
obj = self.session.query(cls).get(record['row_id'])
results.append(LookupResult(object=obj,
+ indexed_name=record['name'],
name=record['display_name'],
language=record['language'],
iso3166=record['iso3166'],
exact = True
form = None
- # Remove any type prefix (pokemon:133) before constructing a query
- if ':' in name:
- prefix_chunk, name = name.split(':', 1)
- name = name.strip()
-
- if not valid_types:
- # Only use types from the query string if none were explicitly
- # provided
- prefixes = prefix_chunk.split(',')
- valid_types = [_.strip() for _ in prefixes]
+ # Pop off any type prefix and merge with valid_types
+ name, merged_valid_types, type_term = \
+ self._apply_valid_types(name, valid_types)
# Random lookup
if name == 'random':
- return self.random_lookup(valid_types=valid_types)
+ return self.random_lookup(valid_types=merged_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
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'__empty__')
+ query = whoosh.query.Term(u'name', name)
- # If there's a space in the input, this might be a form
- if ' ' in name:
- form, formless_name = name.split(' ', 1)
- 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:
- table_name = self._parse_table_name(valid_type)
- if table_name:
- # Quietly ignore bogus valid_types; more likely to DTRT
- type_terms.append(whoosh.query.Term(u'table', table_name))
-
- if type_terms:
- query = query & whoosh.query.Or(type_terms)
+ if type_term:
+ query = query & type_term
### Actual searching
return self.lookup(unicode(n), valid_types=[ partitions[0][0] ])
- def prefix_lookup(self, prefix):
+ def prefix_lookup(self, prefix, valid_types=[]):
"""Returns terms starting with the given exact prefix.
- No special magic is currently done with the name; type prefixes are not
- recognized.
+ Type prefixes are recognized, but no other name munging is done.
"""
+ # Pop off any type prefix and merge with valid_types
+ prefix, merged_valid_types, type_term = \
+ self._apply_valid_types(prefix, valid_types)
+
query = whoosh.query.Prefix(u'name', self.normalize_name(prefix))
+ if type_term:
+ query = query & type_term
+
searcher = self.index.searcher()
searcher.weighting = LanguageWeighting()
results = searcher.search(query) # XXX , limit=self.MAX_LOOKUP_RESULTS)