inspire-query-parser 0.0.0__py2.py3-none-any.whl

inspire_query_parser/__init__.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of INSPIRE.
+# Copyright (C) 2014-2017 CERN.
+#
+# INSPIRE is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# INSPIRE is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with INSPIRE. If not, see <http://www.gnu.org/licenses/>.
+#
+# In applying this license, CERN does not waive the privileges and immunities
+# granted to it by virtue of its status as an Intergovernmental Organization
+# or submit itself to any jurisdiction.
+"""A PEG-based query parser for INSPIRE."""
+
+from __future__ import absolute_import, print_function
+
+from inspire_query_parser import config  # noqa: F401
+from inspire_query_parser.parsing_driver import parse_query  # noqa: F401

inspire_query_parser/ast.py

@@ -0,0 +1,221 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of INSPIRE.
+# Copyright (C) 2014-2017 CERN.
+#
+# INSPIRE is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# INSPIRE is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with INSPIRE. If not, see <http://www.gnu.org/licenses/>.
+#
+# In applying this license, CERN does not waive the privileges and immunities
+# granted to it by virtue of its status as an Intergovernmental Organization
+# or submit itself to any jurisdiction.
+"""AbstractSyntaxTree classes along with their concrete ones.
+
+The module defines a generic AST element along with four AST node
+categories (which act as a basis for all the concrete AST nodes) and
+finally, the concrete classes which represent the output of the parsing
+process.
+
+The generic AST node categories are:     - Leaf     - UnaryOp     -
+BinaryOp     - ListOp
+
+The concrete AST nodes, represent higher level (domain specific) nodes.
+"""
+
+from __future__ import unicode_literals
+
+
+# #### Abstract Syntax Tree classes ####
+class ASTElement(object):
+    """Root AbstractSyntaxTree node that acts as a stub for calling the
+    Visitor's `visit` dispatcher method."""
+
+    def accept(self, visitor, *args, **kwargs):
+        return visitor.visit(self, *args, **kwargs)
+
+
+class Leaf(ASTElement):
+    def __init__(self, value=None):
+        self.value = value
+
+    def __eq__(self, other):
+        return type(self) is type(other) and self.value == other.value
+
+    def __repr__(self):
+        return '%s(%r)' % (self.__class__.__name__, self.value)
+
+    def __hash__(self):
+        return hash(self.value)
+
+
+class UnaryOp(ASTElement):
+    def __init__(self, op):
+        self.op = op
+
+    def __eq__(self, other):
+        return type(self) is type(other) and self.op == other.op
+
+    def __repr__(self):
+        return "%s(%r)" % (self.__class__.__name__, self.op)
+
+    def __hash__(self):
+        return hash(self.op)
+
+
+class BinaryOp(ASTElement):
+    def __init__(self, left, right):
+        self.left = left
+        self.right = right
+
+    def __eq__(self, other):
+        return (
+            (type(self) is type(other))
+            and (self.left == other.left)
+            and (self.right == other.right)
+        )
+
+    def __repr__(self):
+        return "%s(%s, %s)" % (
+            self.__class__.__name__,
+            repr(self.left),
+            repr(self.right),
+        )
+
+    def __hash__(self):
+        return hash((self.left, self.right))
+
+
+class ListOp(ASTElement):
+    def __init__(self, children):
+        try:
+            iter(children)
+        except TypeError:
+            self.children = [children]
+        else:
+            self.children = children
+
+    def __eq__(self, other):
+        return type(self) is type(other) and self.children == other.children
+
+    def __repr__(self):
+        return "%s(%r)" % (self.__class__.__name__, self.children)
+
+    def __hash__(self):
+        return hash(tuple(self.children))
+
+
+# Concrete Syntax Tree classes
+class AndOp(BinaryOp):
+    pass
+
+
+class OrOp(BinaryOp):
+    pass
+
+
+class KeywordOp(BinaryOp):
+    pass
+
+
+class NotOp(UnaryOp):
+    pass
+
+
+class NestedKeywordOp(BinaryOp):
+    pass
+
+
+class ValueOp(UnaryOp):
+    pass
+
+
+class QueryWithMalformedPart(BinaryOp):
+    """A combination of recognized part of a query (with a parse tree) and some
+    malformed input.
+
+    Its left child is the recognized parse tree, while its right child
+    has the :class:`MalformedQuery`.
+    """
+
+    pass
+
+
+class MalformedQuery(ListOp):
+    """A :class:`ListOp` with children the unrecognized words of the parser's
+    input."""
+
+    pass
+
+
+class RangeOp(BinaryOp):
+    pass
+
+
+class GreaterEqualThanOp(UnaryOp):
+    pass
+
+
+class GreaterThanOp(UnaryOp):
+    pass
+
+
+class LessThanOp(UnaryOp):
+    pass
+
+
+class LessEqualThanOp(UnaryOp):
+    pass
+
+
+# #### Leafs ####
+class Keyword(Leaf):
+    pass
+
+
+class GenericValue(Leaf):
+    """Represents a generic value, which might contain a wildcard."""
+
+    WILDCARD_TOKEN = '*'
+
+    def __init__(self, value, contains_wildcard=False):
+        super(GenericValue, self).__init__(value)
+        self.contains_wildcard = contains_wildcard
+
+    def __eq__(self, other):
+        return (
+            super(GenericValue, self).__eq__(other)
+            and self.contains_wildcard == other.contains_wildcard
+        )
+
+    def __hash__(self):
+        return hash((super(GenericValue, self).__hash__(), self.contains_wildcard))
+
+
+class Value(GenericValue):
+    pass
+
+
+class ExactMatchValue(Leaf):
+    pass
+
+
+class PartialMatchValue(GenericValue):
+    pass
+
+
+class RegexValue(Leaf):
+    pass
+
+
+class EmptyQuery(Leaf):
+    pass

inspire_query_parser/config.py

@@ -0,0 +1,238 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of INSPIRE.
+# Copyright (C) 2014-2017 CERN.
+#
+# INSPIRE is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# INSPIRE is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with INSPIRE. If not, see <http://www.gnu.org/licenses/>.
+#
+# In applying this license, CERN does not waive the privileges and immunities
+# granted to it by virtue of its status as an Intergovernmental Organization
+# or submit itself to any jurisdiction.
+"""A collection of INSPIRE related keywords.
+
+This dictionary has a twofold use. Primarily, the parser uses its keys
+to generate INSPIRE related keywords (i.e. qualifiers) and secondly,
+provides a normalization of the shortened keywords to their full
+version.
+"""
+from __future__ import unicode_literals
+
+INSPIRE_PARSER_NONDATE_KEYWORDS = {
+    # Abstract
+    'abstract': 'abstract',
+    # Address
+    'address': 'address',
+    # Affiliation
+    'affiliation': 'affiliation',
+    'affil': 'affiliation',
+    'aff': 'affiliation',
+    'af': 'affiliation',
+    'institution': 'affiliation',
+    'inst': 'affiliation',
+    # Affiliation Id
+    'affid': 'affiliation-id',
+    'affiliation-id': 'affiliation-id',
+    # Author
+    'author': 'author',
+    'au': 'author',
+    'a': 'author',
+    'name': 'author',
+    # Author-Count
+    'author-count': 'author-count',
+    'authorcount': 'author-count',
+    'ac': 'author-count',
+    # Cataloguer
+    'cat': 'cataloguer',
+    # Caption
+    'caption': 'caption',
+    # Cite, i.e. records that cite the given search term
+    # Cite and c: SPIRES syntax while reference is INVENIO syntax
+    'cite': 'cite',
+    'c': 'cite',
+    'reference': 'cite',
+    # Citedby related
+    'citedby': 'citedby',  # nested keyword query
+    # Cited by excluding self sites, e.g. citedbyexcludingselfcites:author:M.E.Peskin.1
+    'citedbyexcludingselfcites': 'citedbyexcludingselfcites',
+    'citedbyx': 'citedbyexcludingselfcites',
+    # Cited excluding self sites, e.g. citedexcludingselfcites:50+
+    'citedexcludingselfcites': 'citedexcludingselfcites',
+    'cx': 'citedexcludingselfcites',
+    # Collaboration
+    'collaboration': 'collaboration',
+    'cn': 'collaboration',
+    # Conference number
+    'cnum': 'confnumber',
+    # Control number
+    'control_number': 'control_number',
+    'recid': 'control_number',
+    # Country
+    'country': 'country',
+    'cc': 'country',
+    # DOI
+    'doi': 'doi',
+    # ePrint
+    'bb': 'eprint',
+    'bull': 'eprint',
+    'eprint': 'eprint',
+    'arxiv': 'eprint',
+    'arXiv': 'eprint',
+    # Exact-Author
+    'exact-author': 'exact-author',
+    'exactauthor': 'exact-author',
+    'ea': 'exact-author',
+    # Experiment
+    'experiment': 'experiment',
+    'exp': 'experiment',
+    # Field-code
+    'fc': 'field-code',
+    'field-code': 'field-code',
+    # First-Author
+    'first-author': 'first_author',
+    'firstauthor': 'first_author',
+    'fa': 'first_author',
+    # Fulltext
+    'fulltext': 'fulltext',
+    'ft': 'fulltext',
+    # SPIRES identifiers
+    'irn': 'irn',
+    # Journal related
+    'coden': 'journal',
+    'journal': 'journal',
+    'j': 'journal',
+    'published_in': 'journal',
+    'volume': 'volume',
+    'vol': 'volume',
+    # Keyword
+    # keyword is Invenio style, while the rest are from SPIRES syntax.
+    'keyword': 'keyword',
+    'keywords': 'keyword',
+    'kw': 'keyword',
+    'k': 'keyword',
+    # Primary archive
+    'primarch': 'primary_arxiv_category',
+    # rawref
+    'rawref': 'rawref',
+    # Reference
+    'citation': 'reference',
+    'jour-vol-page': 'reference',
+    'jvp': 'reference',
+    # Refersto operator
+    # Nested keyword query
+    'refersto': 'refersto',
+    # Refers to excluding self cites,
+    # e.g. referstoexcludingselfcites:author:M.E.Peskin.1
+    # Nested keyword queries
+    'referstoexcludingselfcites': 'referstoexcludingselfcites',
+    'referstox': 'referstoexcludingselfcites',
+    # Report number
+    'reportnumber': 'reportnumber',
+    'report-num': 'reportnumber',
+    'report': 'reportnumber',
+    'rept': 'reportnumber',
+    'rn': 'reportnumber',
+    'r': 'reportnumber',
+    # Subject
+    'subject': 'subject',
+    # Title
+    'title': 'title',
+    'ti': 'title',
+    't': 'title',
+    # texkey
+    'texkey': 'texkeys.raw',
+    # Topcite, i.e. citation count
+    # Cited used to be for Invenio style syntax while topcite for SPIRES
+    'cited': 'topcite',
+    'topcit': 'topcite',
+    'topcite': 'topcite',
+    # Type-Code
+    'type-code': 'type-code',
+    'type': 'type-code',
+    'tc': 'type-code',
+    'ty': 'type-code',
+    'scl': 'type-code',
+    'ps': 'type-code',
+    'collection': 'type-code',# Queries for this one include "collection published" only
+}
+
+INSPIRE_PARSER_DATE_KEYWORDS = {
+    # Date
+    'date': 'date',
+    'd': 'date',
+    # From queries dataset, users seem to use year and date interchangeably.
+    'year': 'date',
+    # Date added
+    'date-added': 'date-added',
+    'dadd': 'date-added',
+    'da': 'date-added',
+    # Date earliest
+    'date-earliest': 'date-earliest',
+    'de': 'date-earliest',
+    # Date updated
+    'date-updated': 'date-updated',
+    'dupd': 'date-updated',
+    'du': 'date-updated',
+    # Journal year
+    'journal-year': 'publication_info.year',
+    'jy': 'publication_info.year',
+}
+
+INSPIRE_PARSER_KEYWORDS = INSPIRE_PARSER_NONDATE_KEYWORDS.copy()
+INSPIRE_PARSER_KEYWORDS.update(INSPIRE_PARSER_DATE_KEYWORDS)
+INSPIRE_KEYWORDS_SET = set(INSPIRE_PARSER_KEYWORDS.values())
+
+# #### Date specifiers #####
+DATE_TODAY_REGEX_PATTERN = 'today'
+DATE_YESTERDAY_REGEX_PATTERN = 'yesterday'
+DATE_LAST_MONTH_REGEX_PATTERN = 'last\s+month'
+DATE_THIS_MONTH_REGEX_PATTERN = 'this\s+month'
+
+DATE_SPECIFIERS_COLLECTION = (
+    DATE_TODAY_REGEX_PATTERN,
+    DATE_YESTERDAY_REGEX_PATTERN,
+    DATE_THIS_MONTH_REGEX_PATTERN,
+    DATE_LAST_MONTH_REGEX_PATTERN,
+)
+MONTH_REGEX = "|".join(
+    [
+        "january",
+        "jan",
+        "february",
+        "feb",
+        "march",
+        "mar",
+        "april",
+        "apr",
+        "may",
+        "june",
+        'jun',
+        "july",
+        "jul",
+        "august",
+        "aug",
+        "september",
+        "sep",
+        "october",
+        "oct",
+        "november",
+        "nov",
+        "december",
+        "dec",
+    ]
+)
+# #####
+
+ES_MUST_QUERY = "must"
+ES_SHOULD_QUERY = "should"
+DEFAULT_ES_OPERATOR_FOR_MALFORMED_QUERIES = ES_MUST_QUERY