diff --git a/pubs/commands/list_cmd.py b/pubs/commands/list_cmd.py index 5884cdc..2c1ec90 100644 --- a/pubs/commands/list_cmd.py +++ b/pubs/commands/list_cmd.py @@ -2,32 +2,27 @@ from datetime import datetime from .. import repo from .. import pretty -from .. import bibstruct from ..uis import get_ui - - -class InvalidQuery(ValueError): - pass +from ..query import get_paper_filter, QUERY_HELP def parser(subparsers, conf): parser = subparsers.add_parser('list', help="list papers") parser.add_argument('-k', '--citekeys-only', action='store_true', - default=False, dest='citekeys', - help='Only returns citekeys of matching papers.') + default=False, dest='citekeys', + help='Only returns citekeys of matching papers.') parser.add_argument('-i', '--ignore-case', action='store_false', - default=None, dest='case_sensitive') + default=None, dest='case_sensitive') parser.add_argument('-I', '--force-case', action='store_true', - dest='case_sensitive') + dest='case_sensitive') parser.add_argument('-a', '--alphabetical', action='store_true', - dest='alphabetical', default=False, - help='lexicographic order on the citekeys.') + dest='alphabetical', default=False, + help='lexicographic order on the citekeys.') parser.add_argument('--no-docs', action='store_true', - dest='nodocs', default=False, - help='list only pubs without attached documents.') - + dest='nodocs', default=False, + help='list only pubs without attached documents.') parser.add_argument('query', nargs='*', - help='Paper query ("author:Einstein", "title:learning", "year:2000" or "tags:math")') + help=QUERY_HELP) return parser @@ -38,8 +33,8 @@ def date_added(p): def command(conf, args): ui = get_ui() rp = repo.Repository(conf) - papers = filter(lambda p: filter_paper(p, args.query, - case_sensitive=args.case_sensitive), + papers = filter(get_paper_filter(args.query, + case_sensitive=args.case_sensitive), rp.all_papers()) if args.nodocs: papers = [p for p in papers if p.docpath is None] @@ -53,74 +48,3 @@ def command(conf, args): for p in papers)) rp.close() - - -FIELD_ALIASES = { - 'a': 'author', - 'authors': 'author', - 't': 'title', - 'tags': 'tag', - } - - -def _get_field_value(query_block): - split_block = query_block.split(':') - if len(split_block) != 2: - raise InvalidQuery("Invalid query (%s)" % query_block) - field = split_block[0] - if field in FIELD_ALIASES: - field = FIELD_ALIASES[field] - value = split_block[1] - return (field, value) - - -def _lower(s, lower=True): - return s.lower() if lower else s - - -def _check_author_match(paper, query, case_sensitive=False): - """Only checks within last names.""" - if not 'author' in paper.bibdata: - return False - return any([query in _lower(bibstruct.author_last(p), lower=(not case_sensitive)) - for p in paper.bibdata['author']]) - - - -def _check_tag_match(paper, query, case_sensitive=False): - return any([query in _lower(t, lower=(not case_sensitive)) - for t in paper.tags]) - - -def _check_field_match(paper, field, query, case_sensitive=False): - return query in _lower(paper.bibdata[field], - lower=(not case_sensitive)) - - -def _check_query_block(paper, query_block, case_sensitive=None): - field, value = _get_field_value(query_block) - if case_sensitive is None: - case_sensitive = not value.islower() - elif not case_sensitive: - value = value.lower() - if field == 'tag': - return _check_tag_match(paper, value, case_sensitive=case_sensitive) - elif field == 'author': - return _check_author_match(paper, value, case_sensitive=case_sensitive) - elif field in paper.bibdata: - return _check_field_match(paper, field, value, - case_sensitive=case_sensitive) - else: - return False - - -# TODO implement search by type of document -def filter_paper(paper, query, case_sensitive=None): - """If case_sensitive is not given, only check case if query - is not lowercase. - - :args query: list of query blocks (strings) - """ - return all([_check_query_block(paper, query_block, - case_sensitive=case_sensitive) - for query_block in query]) diff --git a/pubs/query.py b/pubs/query.py new file mode 100644 index 0000000..baa17ca --- /dev/null +++ b/pubs/query.py @@ -0,0 +1,135 @@ +from . import bibstruct + + +QUERY_HELP = ('Paper query ("author:Einstein", "title:learning",' + '"year:2000", "year:2000-2010", or "tags:math")') + + +FIELD_ALIASES = { + 'a': 'author', + 'authors': 'author', + 't': 'title', + 'tags': 'tag', + 'y': 'year', +} + + +class InvalidQuery(ValueError): + pass + + +class QueryFilter(object): + + def __init__(self, query, case_sensitive=None): + if case_sensitive is None: + case_sensitive = not query.islower() + self.case = case_sensitive + self.query = self._lower(query) + + def __call__(self, paper): + raise NotImplementedError + + def _lower(self, s): + return s if self.case else s.lower() + + +class FieldFilter(QueryFilter): + """Generic filter of form `query in paper['field']`""" + + def __init__(self, field, query, case_sensitive=None): + super(FieldFilter, self).__init__(query, case_sensitive=case_sensitive) + self.field = field + + def __call__(self, paper): + return (self.field in paper.bibdata and + self.query in self._lower(paper.bibdata[self.field])) + + +class AuthorFilter(QueryFilter): + + def __call__(self, paper): + """Only checks within last names.""" + if 'author' not in paper.bibdata: + return False + else: + return any([self.query in self._lower(bibstruct.author_last(author)) + for author in paper.bibdata['author']]) + + +class TagFilter(QueryFilter): + + def __call__(self, paper): + return any([self.query in self._lower(t) for t in paper.tags]) + + +class YearFilter(QueryFilter): + """Note: a query like `year:` or `year:-` would match any paper + whose year field is set and can be converted to an int. + """ + + def __init__(self, query, case_sensitive=None): + split = query.split('-') + self.start = self._str_to_year(split[0]) + if len(split) == 1: + self.end = self.start + elif len(split) == 2: + self.end = self._str_to_year(split[1]) + if (len(split) > 2 or ( + self.start is not None and + self.end is not None and + self.start > self.end)): + raise ValueError('Invalid year range "{}"'.format(query)) + + def __call__(self, paper): + """Only checks within last names.""" + if 'year' not in paper.bibdata: + return False + else: + try: + year = int(paper.bibdata['year']) + return ((self.start is None or year >= self.start) and + (self.end is None or year <= self.end)) + except ValueError: + return False + + @staticmethod + def _str_to_year(s): + try: + return int(s) if s else None + except ValueError: + raise ValueError('Invalid year "{}"'.format(s)) + + +def _get_field_value(query_block): + split_block = query_block.split(':') + if len(split_block) != 2: + raise InvalidQuery("Invalid query (%s)" % query_block) + field = split_block[0] + if field in FIELD_ALIASES: + field = FIELD_ALIASES[field] + value = split_block[1] + return (field, value) + + +def _query_block_to_filter(query_block, case_sensitive=None): + field, value = _get_field_value(query_block) + if field == 'tag': + return TagFilter(value, case_sensitive=case_sensitive) + elif field == 'author': + return AuthorFilter(value, case_sensitive=case_sensitive) + elif field == 'year': + return YearFilter(value) + else: + return FieldFilter(field, value, case_sensitive=case_sensitive) + + +# TODO implement search by type of document +def get_paper_filter(query, case_sensitive=None): + """If case_sensitive is not given, only check case if query + is not lowercase. + + :args query: list of query blocks (strings) + """ + filters = [_query_block_to_filter(query_block, case_sensitive=case_sensitive) + for query_block in query] + return lambda paper: all([f(paper) for f in filters]) diff --git a/tests/test_queries.py b/tests/test_queries.py index 6ea7a10..245833b 100644 --- a/tests/test_queries.py +++ b/tests/test_queries.py @@ -1,11 +1,9 @@ import unittest import dotdot -from pubs.commands.list_cmd import (_check_author_match, - _check_field_match, - _check_query_block, - filter_paper, - InvalidQuery) +from pubs.query import (AuthorFilter, FieldFilter, YearFilter, + _query_block_to_filter, get_paper_filter, + InvalidQuery) from pubs.paper import Paper @@ -16,86 +14,113 @@ page_paper = Paper.from_bibentry(fixtures.page_bibentry) turing_paper = Paper.from_bibentry(fixtures.turing_bibentry, metadata=fixtures.turing_metadata) + class TestAuthorFilter(unittest.TestCase): def test_fails_if_no_author(self): no_doe = doe_paper.deepcopy() no_doe.bibentry['author'] = [] - self.assertTrue(not _check_author_match(no_doe, 'whatever')) + self.assertFalse(AuthorFilter('whatever')(no_doe)) def test_match_case(self): - self.assertTrue(_check_author_match(doe_paper, 'doe')) - self.assertTrue(_check_author_match(doe_paper, 'doe', - case_sensitive=False)) + self.assertTrue(AuthorFilter('doe')(doe_paper)) + self.assertTrue(AuthorFilter('doe', case_sensitive=False)(doe_paper)) + self.assertTrue(AuthorFilter('Doe')(doe_paper)) def test_do_not_match_case(self): - self.assertFalse(_check_author_match(doe_paper, 'dOe')) - self.assertFalse(_check_author_match(doe_paper, 'doe', - case_sensitive=True)) + self.assertFalse(AuthorFilter('dOe')(doe_paper)) + self.assertFalse(AuthorFilter('dOe', case_sensitive=True)(doe_paper)) + self.assertFalse(AuthorFilter('doe', case_sensitive=True)(doe_paper)) + self.assertTrue(AuthorFilter('dOe', case_sensitive=False)(doe_paper)) def test_match_not_first_author(self): - self.assertTrue(_check_author_match(page_paper, 'motwani')) + self.assertTrue(AuthorFilter('motwani')(page_paper)) def test_do_not_match_first_name(self): - self.assertTrue(not _check_author_match(page_paper, 'larry')) + self.assertFalse(AuthorFilter('lawrence')(page_paper)) class TestCheckTag(unittest.TestCase): pass +class TestCheckYear(unittest.TestCase): + + def test_single_year(self): + self.assertTrue(YearFilter('2013')(doe_paper)) + self.assertFalse(YearFilter('2014')(doe_paper)) + + def test_before_year(self): + self.assertTrue(YearFilter('-2013')(doe_paper)) + self.assertTrue(YearFilter('-2014')(doe_paper)) + self.assertFalse(YearFilter('-2012')(doe_paper)) + + def test_after_year(self): + self.assertTrue(YearFilter('2013-')(doe_paper)) + self.assertTrue(YearFilter('2012-')(doe_paper)) + self.assertFalse(YearFilter('2014-')(doe_paper)) + + def test_year_range(self): + self.assertTrue(YearFilter('')(doe_paper)) + self.assertTrue(YearFilter('-')(doe_paper)) + self.assertTrue(YearFilter('2013-2013')(doe_paper)) + self.assertTrue(YearFilter('2012-2014')(doe_paper)) + self.assertFalse(YearFilter('2014-2015')(doe_paper)) + with self.assertRaises(ValueError): + YearFilter('2015-2014')(doe_paper) + + class TestCheckField(unittest.TestCase): def test_match_case(self): - self.assertTrue(_check_field_match(doe_paper, 'title', 'nice')) - self.assertTrue(_check_field_match(doe_paper, 'title', 'nice', - case_sensitive=False)) - self.assertTrue(_check_field_match(doe_paper, 'year', '2013')) + self.assertTrue(FieldFilter('title', 'nice')(doe_paper)) + self.assertTrue( + FieldFilter('title', 'nice', case_sensitive=False)(doe_paper)) + self.assertTrue(FieldFilter('year', '2013')(doe_paper)) def test_do_not_match_case(self): - self.assertTrue(_check_field_match(doe_paper, 'title', - 'Title', case_sensitive=True)) - self.assertFalse(_check_field_match(doe_paper, 'title', 'nice', - case_sensitive=True)) + self.assertTrue( + FieldFilter('title', 'Title', case_sensitive=True)(doe_paper)) + self.assertFalse( + FieldFilter('title', 'nice', case_sensitive=True)(doe_paper)) class TestCheckQueryBlock(unittest.TestCase): def test_raise_invalid_if_no_value(self): with self.assertRaises(InvalidQuery): - _check_query_block(doe_paper, 'title') + _query_block_to_filter('title') def test_raise_invalid_if_too_much(self): with self.assertRaises(InvalidQuery): - _check_query_block(doe_paper, 'whatever:value:too_much') + _query_block_to_filter('whatever:value:too_much') class TestFilterPaper(unittest.TestCase): def test_case(self): - self.assertTrue (filter_paper(doe_paper, ['title:nice'])) - self.assertTrue (filter_paper(doe_paper, ['title:Nice'])) - self.assertFalse(filter_paper(doe_paper, ['title:nIce'])) + self.assertTrue(get_paper_filter(['title:nice'])(doe_paper)) + self.assertTrue(get_paper_filter(['title:Nice'])(doe_paper)) + self.assertFalse(get_paper_filter(['title:nIce'])(doe_paper)) def test_fields(self): - self.assertTrue (filter_paper(doe_paper, ['year:2013'])) - self.assertFalse(filter_paper(doe_paper, ['year:2014'])) - self.assertTrue (filter_paper(doe_paper, ['author:doe'])) - self.assertTrue (filter_paper(doe_paper, ['author:Doe'])) + self.assertTrue(get_paper_filter(['year:2013'])(doe_paper)) + self.assertTrue(get_paper_filter(['year:2010-'])(doe_paper)) + self.assertFalse(get_paper_filter(['year:2014'])(doe_paper)) + self.assertTrue(get_paper_filter(['author:doe'])(doe_paper)) + self.assertTrue(get_paper_filter(['author:Doe'])(doe_paper)) def test_tags(self): - self.assertTrue (filter_paper(turing_paper, ['tag:computer'])) - self.assertFalse(filter_paper(turing_paper, ['tag:Ai'])) - self.assertTrue (filter_paper(turing_paper, ['tag:AI'])) - self.assertTrue (filter_paper(turing_paper, ['tag:ai'])) + self.assertTrue(get_paper_filter(['tag:computer'])(turing_paper)) + self.assertFalse(get_paper_filter(['tag:Ai'])(turing_paper)) + self.assertTrue(get_paper_filter(['tag:AI'])(turing_paper)) + self.assertTrue(get_paper_filter(['tag:ai'])(turing_paper)) def test_multiple(self): - self.assertTrue (filter_paper(doe_paper, - ['author:doe', 'year:2013'])) - self.assertFalse(filter_paper(doe_paper, - ['author:doe', 'year:2014'])) - self.assertFalse(filter_paper(doe_paper, - ['author:doee', 'year:2014'])) + self.assertTrue(get_paper_filter(['author:doe', 'year:2013'])(doe_paper)) + self.assertTrue(get_paper_filter(['author:doe', 'year:2010-2014'])(doe_paper)) + self.assertFalse(get_paper_filter(['author:doe', 'year:2014-'])(doe_paper)) + self.assertFalse(get_paper_filter(['author:doee', 'year:2014'])(doe_paper)) if __name__ == '__main__':