Statistics
| Branch: | Tag: | Revision:

root / lib / qlang.py @ e9f7d26a

History | View | Annotate | Download (1.9 kB)

1 a123dc19 Michael Hanselmann
#
2 a123dc19 Michael Hanselmann
#
3 a123dc19 Michael Hanselmann
4 341ff8e9 Michael Hanselmann
# Copyright (C) 2010, 2011 Google Inc.
5 a123dc19 Michael Hanselmann
#
6 a123dc19 Michael Hanselmann
# This program is free software; you can redistribute it and/or modify
7 a123dc19 Michael Hanselmann
# it under the terms of the GNU General Public License as published by
8 a123dc19 Michael Hanselmann
# the Free Software Foundation; either version 2 of the License, or
9 a123dc19 Michael Hanselmann
# (at your option) any later version.
10 a123dc19 Michael Hanselmann
#
11 a123dc19 Michael Hanselmann
# This program is distributed in the hope that it will be useful, but
12 a123dc19 Michael Hanselmann
# WITHOUT ANY WARRANTY; without even the implied warranty of
13 a123dc19 Michael Hanselmann
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 a123dc19 Michael Hanselmann
# General Public License for more details.
15 a123dc19 Michael Hanselmann
#
16 a123dc19 Michael Hanselmann
# You should have received a copy of the GNU General Public License
17 a123dc19 Michael Hanselmann
# along with this program; if not, write to the Free Software
18 a123dc19 Michael Hanselmann
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 a123dc19 Michael Hanselmann
# 02110-1301, USA.
20 a123dc19 Michael Hanselmann
21 a123dc19 Michael Hanselmann
22 341ff8e9 Michael Hanselmann
"""Module for a simple query language
23 341ff8e9 Michael Hanselmann

24 341ff8e9 Michael Hanselmann
A query filter is always a list. The first item in the list is the operator
25 341ff8e9 Michael Hanselmann
(e.g. C{[OP_AND, ...]}), while the other items depend on the operator. For
26 341ff8e9 Michael Hanselmann
logic operators (e.g. L{OP_AND}, L{OP_OR}), they are subfilters whose results
27 341ff8e9 Michael Hanselmann
are combined. Unary operators take exactly one other item (e.g. a subfilter for
28 341ff8e9 Michael Hanselmann
L{OP_NOT} and a field name for L{OP_TRUE}). Binary operators take exactly two
29 341ff8e9 Michael Hanselmann
operands, usually a field name and a value to compare against. Filters are
30 341ff8e9 Michael Hanselmann
converted to callable functions by L{query._CompileFilter}.
31 341ff8e9 Michael Hanselmann

32 341ff8e9 Michael Hanselmann
"""
33 a123dc19 Michael Hanselmann
34 341ff8e9 Michael Hanselmann
# Logic operators with one or more operands, each of which is a filter on its
35 341ff8e9 Michael Hanselmann
# own
36 a123dc19 Michael Hanselmann
OP_OR = "|"
37 88076fd1 Michael Hanselmann
OP_AND = "&"
38 88076fd1 Michael Hanselmann
39 88076fd1 Michael Hanselmann
40 341ff8e9 Michael Hanselmann
# Unary operators with exactly one operand
41 88076fd1 Michael Hanselmann
OP_NOT = "!"
42 3b877f08 Michael Hanselmann
OP_TRUE = "?"
43 88076fd1 Michael Hanselmann
44 88076fd1 Michael Hanselmann
45 341ff8e9 Michael Hanselmann
# Binary operators with exactly two operands, the field name and an
46 341ff8e9 Michael Hanselmann
# operator-specific value
47 a123dc19 Michael Hanselmann
OP_EQUAL = "="
48 88076fd1 Michael Hanselmann
OP_NOT_EQUAL = "!="
49 88076fd1 Michael Hanselmann
OP_GLOB = "=*"
50 88076fd1 Michael Hanselmann
OP_REGEXP = "=~"
51 88076fd1 Michael Hanselmann
OP_CONTAINS = "=[]"
52 a123dc19 Michael Hanselmann
53 a123dc19 Michael Hanselmann
54 60cba7f8 Michael Hanselmann
def MakeSimpleFilter(namefield, values):
55 31554d0a Michael Hanselmann
  """Builds simple a filter.
56 60cba7f8 Michael Hanselmann

57 60cba7f8 Michael Hanselmann
  @param namefield: Name of field containing item name
58 60cba7f8 Michael Hanselmann
  @param values: List of names
59 60cba7f8 Michael Hanselmann

60 60cba7f8 Michael Hanselmann
  """
61 60cba7f8 Michael Hanselmann
  if values:
62 60cba7f8 Michael Hanselmann
    return [OP_OR] + [[OP_EQUAL, namefield, i] for i in values]
63 60cba7f8 Michael Hanselmann
64 60cba7f8 Michael Hanselmann
  return None