Module ImportFrom alias identifier ImportFrom alias ImportFrom alias alias alias alias alias alias alias alias alias ImportFrom alias alias ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults body Assign AttributeStore NameLoad attr NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam NameParam defaults body Assign NameStore Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad NameLoad NameLoad NameLoad Assign NameStore Dict TryExcept body Assign NameStore ListComp NameLoad comprehension NameStore NameLoad Call NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr For NameStore NameLoad body Assign NameStore Call NameLoad Call NameLoad NameLoad Str NameLoad Str NameLoad If NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad handlers ExceptHandler type NameLoad body Pass For TupleStore NameStore NameStore Call AttributeLoad NameLoad attr body If Call NameLoad NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad Expr Call NameLoad NameLoad NameLoad Assign AttributeStore NameLoad attr Call NameLoad NameLoad Return NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str Assign NameStore NameLoad FunctionDef arguments args NameParam defaults kwarg body For TupleStore NameStore NameStore Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr body Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad Expr Call NameLoad NameLoad NameLoad NameLoad Assign AttributeStore NameLoad attr BoolOpOr Call AttributeLoad Call NameLoad Call AttributeLoad NameLoad attr Str Str attr Str NameLoad Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr Str decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad Str If CompareIn NameLoad AttributeLoad NameLoad attr body Assign NameStore SubscriptLoad AttributeLoad NameLoad attr Index NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str If CompareIn NameLoad AttributeLoad AttributeLoad NameLoad attr attr body Assign NameStore SubscriptLoad AttributeLoad AttributeLoad NameLoad attr attr Index NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return Dict decorator_list FunctionDef arguments args NameParam defaults body Expr Str If UnaryOpNot Call NameLoad NameLoad Str body Assign NameStore Call AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr DictComp NameLoad BoolOpOr Call AttributeLoad NameLoad attr NameLoad Call NameLoad NameLoad NameLoad NameLoad comprehension NameStore AttributeLoad AttributeLoad NameLoad attr attr Return AttributeLoad NameLoad attr decorator_list decorator_list ClassDef bases NameLoad body Expr Str Assign NameStore Dict NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad NameLoad body If UnaryOpNot NameLoad body Raise Call NameLoad Str If BoolOpOr Call AttributeLoad NameLoad attr Str CompareIn Str NameLoad body Raise Call NameLoad Str Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr keyword NameLoad decorator_list FunctionDef arguments args NameParam defaults kwarg body Expr Str Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad kwarg body Expr Str Assign NameStore Call AttributeLoad NameLoad attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Assign NameStore BoolOpOr NameLoad AttributeLoad NameLoad attr If NameLoad body Return ListComp AttributeLoad NameLoad attr comprehension NameStore NameLoad If NameLoad body Return ListComp Call NameLoad NameLoad NameLoad comprehension NameStore NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Assign NameStore BoolOpOr NameLoad AttributeLoad NameLoad attr If BoolOpAnd NameLoad NameLoad body Return Call NameLoad NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Lambda arguments args NameParam NameParam NameParam defaults Call SubscriptLoad AttributeLoad NameLoad attr Index Call NameLoad NameLoad keyword NameLoad keyword NameLoad Return ListComp Call NameLoad NameLoad NameLoad Call AttributeLoad NameLoad attr Call NameLoad NameLoad NameLoad NameLoad comprehension TupleStore NameStore NameStore Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr decorator_list TryExcept body Expr Call NameLoad NameLoad handlers ExceptHandler type NameLoad body Assign NameStore ListLoad NameLoad Assign NameStore ListComp Call AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword Call NameLoad NameLoad comprehension NameStore NameLoad Return Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call AttributeLoad NameLoad attr keyword NameLoad While NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr keyword NameLoad keyword SubscriptLoad NameLoad Index Num keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Assign NameStore BoolOpOr NameLoad AttributeLoad NameLoad attr If UnaryOpNot NameLoad body Raise Call NameLoad Str Return Call NameLoad AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad decorator_list decorator_list
N/A google.appengine.api search search_api errors DocumentClassRequiredError fields TextField IntegerField FloatField DateField Field BooleanField HtmlField AtomField GeoField query SearchQuery construct_document Options N/A object N/A N/A Similar to Django's Options class, holds metadata about a class with
    `__metaclass__ = MetaClass`.
     __init__ N/A N/A self fields N/A N/A N/A N/A self fields fields N/A N/A MetaClass N/A type N/A N/A Allows the typical declarative class pattern:

    >>> class Thing(search.Document):
    ...     prop = search.Field()
    ...
    >>> t = Thing()
    >>> t.prop = 'hello'
    >>> t.prop
    'Hello'
    >>> Thing.prop
    Traceback ...:
        ...
    AttributeError: type object 'Thing' has no attribute 'prop'
    >>> Thing._meta.fields['prop']
    <search.Field object at 0xXXXXXXXX>
     __new__ N/A N/A cls name bases dct N/A N/A N/A new_cls N/A N/A N/A super MetaClass cls __new__ cls name bases dct N/A fields N/A N/A N/A N/A parents N/A b N/A b bases N/A issubclass b DocumentModel N/A N/A N/A parents reverse N/A p parents N/A N/A parent_fields N/A getattr N/A getattr p _meta None fields None N/A parent_fields N/A N/A N/A N/A fields update parent_fields N/A N/A N/A NameError N/A N/A N/A N/A name field N/A N/A dct items N/A N/A N/A isinstance field Field N/A N/A N/A N/A field add_to_class new_cls name N/A N/A fields N/A name field N/A N/A delattr new_cls name N/A N/A new_cls _meta N/A Options fields N/A new_cls N/A N/A DocumentModel N/A object N/A N/A Base class for documents added to search indexes N/A __metaclass__ MetaClass __init__ N/A N/A self N/A kwargs N/A N/A N/A name field N/A N/A N/A N/A self _meta fields items N/A N/A val N/A N/A kwargs pop name None N/A N/A setattr self name val N/A N/A self doc_id N/A N/A N/A N/A unicode N/A N/A kwargs get doc_id encode utf-8 None N/A N/A self _rank N/A N/A kwargs get _rank N/A __getattribute__ N/A N/A self name N/A N/A N/A Make sure that any attribute accessed on document classes returns the
        python representation of its value.
         N/A val N/A N/A object __getattribute__ self name N/A meta N/A N/A object __getattribute__ self _meta N/A N/A name N/A meta fields N/A N/A f N/A N/A meta fields N/A name N/A val N/A N/A f to_python val N/A val N/A __setattr__ N/A N/A self name val N/A N/A N/A Make sure that any attibutes set on document class instances get the
        value converted to the search API accepted value.
         N/A N/A name N/A N/A self _meta fields N/A N/A f N/A N/A N/A self _meta fields N/A name N/A val N/A N/A f to_search_value val N/A N/A N/A N/A super DocumentModel self __setattr__ name val N/A get_snippets N/A N/A self N/A N/A N/A Get the snippets for this document as a dictionary of the form:

            {"field_name": "snippet for this field, if there is one"}

        Returns an empty dict if this document hasn't been returned as part of
        a search query (since it can only be populated then.)
         N/A N/A N/A snippet_or_value N/A N/A self N/A N/A N/A Goes through each of this document's snippeted fields and constructs
        a dictionary where each field name points either to the snippet for
        that field if there is one, or just the plain value for that field on
        the document.
         N/A N/A N/A hasattr self _snippets_or_values N/A N/A snippets N/A N/A self get_snippets N/A N/A self _snippets_or_values N/A field N/A N/A N/A snippets get field N/A getattr self field None N/A field N/A N/A self _meta fields N/A N/A self _snippets_or_values N/A N/A Index N/A object N/A N/A A search index. Provides methods for adding, removing and searching
    documents in this index.
     N/A FIELD_MAP N/A TextField HtmlField IntegerField FloatField DateField BooleanField AtomField GeoField N/A search_api TextField N/A search_api HtmlField N/A search_api NumberField N/A search_api NumberField N/A search_api DateField N/A search_api NumberField N/A search_api AtomField N/A search_api GeoField __init__ N/A N/A self name document_class N/A None None N/A N/A N/A name N/A N/A N/A ValueError An index must have a non empty name N/A N/A N/A N/A name startswith ! N/A name N/A N/A N/A ValueError Index names can't start with a '!' or contain spaces N/A N/A self name name N/A N/A self document_class document_class N/A N/A self _index N/A N/A search_api Index name name N/A list_documents N/A N/A self N/A kwargs N/A N/A Deprecated. Use `get_range` instead N/A N/A N/A self get_range kwargs N/A add N/A N/A self documents N/A N/A N/A Deprecated. Use `put` instead N/A N/A N/A self put documents N/A remove N/A N/A self doc_ids N/A N/A N/A Deprecated. Use `delete` instead N/A N/A N/A self delete doc_ids N/A get_range N/A N/A self document_class N/A None kwargs N/A N/A Get a list of documents from the Search API without actually doing
        a search.

        Takes all the same kwargs that the Search API's get_range takes, plus a
        `document_class` arg for which to construct document objects. If it's
        omitted, the documents are returned as they would be normally from the
        Search API.
         N/A ids_only N/A N/A kwargs get ids_only N/A docs N/A N/A N/A self _index get_range kwargs N/A document_class N/A document_class N/A self document_class N/A ids_only N/A N/A N/A N/A doc doc_id N/A doc docs N/A document_class N/A N/A N/A N/A construct_document document_class doc N/A doc docs N/A docs N/A get N/A N/A self doc_id document_class N/A None N/A N/A Get a document from this index by its ID. It'll be returned as an
        instance of the given `document_class`. Returns `None` if there's no
        document by that ID.
         N/A doc N/A N/A N/A self _index get doc_id N/A document_class N/A document_class N/A self document_class N/A N/A doc document_class N/A N/A N/A construct_document document_class doc N/A doc N/A put N/A N/A self documents N/A N/A N/A Add `documents` to this index get_fields N/A N/A d N/A N/A N/A Convenience function for getting the search API fields list
            from the given document `d`.
             N/A field N/A N/A N/A f n v N/A N/A N/A N/A self FIELD_MAP N/A N/A type f name n value v N/A N/A N/A field f n N/A N/A f to_search_value N/A getattr d n None N/A N/A n f N/A N/A N/A N/A d _meta fields items N/A N/A N/A N/A N/A len documents N/A N/A N/A TypeError N/A N/A documents N/A documents N/A search_docs N/A N/A N/A search_api Document doc_id N/A d doc_id rank N/A d _rank fields N/A get_fields d N/A d documents N/A N/A N/A N/A self _index put search_docs N/A delete N/A N/A self doc_ids N/A N/A N/A Delete documents with the given `doc_ids` from this index N/A N/A N/A N/A self _index delete doc_ids N/A purge N/A N/A self N/A N/A N/A Deletes all documents from this index.

        Probably don't use this on production unless the index only holds
        a really small number of documents. Use App Engine's tasks to delete
        documents in batches instead.
         N/A doc_ids N/A N/A self get_range ids_only True N/A doc_ids N/A N/A N/A N/A self delete doc_ids N/A doc_ids N/A N/A self get_range ids_only True start_id N/A doc_ids N/A -1 include_start_object False N/A search N/A N/A self document_class ids_only N/A None False N/A N/A Initialise the search query for this index and document class N/A document_class N/A document_class N/A self document_class N/A N/A document_class N/A N/A N/A DocumentClassRequiredError A document class must be provided to instantiate with query results. Either instantiate the index object with one, or pass one to the search method. N/A N/A SearchQuery N/A self _index document_class document_class ids_only ids_only N/A N/A