Python 2.7 has reached end of support
and will be
deprecated
on January 31, 2026. After deprecation, you won't be able to deploy Python 2.7
applications, even if your organization previously used an organization policy to
re-enable deployments of legacy runtimes. Your existing Python
2.7 applications will continue to run and receive traffic after their
deprecation date. We recommend that
you
migrate to the latest supported version of Python.
Stay organized with collections
Save and categorize content based on your preferences.
google.appengine.api.search.search_util module
Summary
Provides utility methods used by modules in the FTS API stub.
Contents
- google.appengine.api.search.search_util.AddFieldsToDocumentPb(doc_id, fields, document)source
Add the id and fields to document.
Parameters
-
doc_id – The document id.
-
fields – List of tuples of field name, value and optionally type.
-
document – The document to add the fields to.
- google.appengine.api.search.search_util.ConvertToNfkd(text)source
- google.appengine.api.search.search_util.DeserializeDate(date_str)source
- google.appengine.api.search.search_util.EpochTime(date)source
-
Returns millisecond epoch time for a date or datetime.
- google.appengine.api.search.search_util.GetAllFieldInDocument(document, field_name)source
-
Find and return all fields with the provided name in the document.
- google.appengine.api.search.search_util.GetFieldCountInDocument(document, field_name)source
- google.appengine.api.search.search_util.GetFieldInDocument(document, field_name, return_type=None)source
-
Find and return the field with the provided name and type.
- google.appengine.api.search.search_util.RemoveAccents(text)source
- google.appengine.api.search.search_util.RemoveAccentsNfkd(text)source
- google.appengine.api.search.search_util.Repr(class_instance, ordered_dictionary)source
-
Generates an unambiguous representation for instance and ordered dict.
- google.appengine.api.search.search_util.SerializeDate(date)source
- google.appengine.api.search.search_util.TreeRepr(tree, depth=0)source
-
Generate a string representation of an ANTLR parse tree for debugging.
- exception google.appengine.api.search.search_util.UnsupportedOnDevErrorsource
-
Bases: exceptions.Exception
Indicates attempt to perform an action unsupported on the dev server.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-16 UTC."],[[["The `google.appengine.api.search.search_util` module offers utility methods for the Full Text Search (FTS) API stub."],["This module provides functionalities to add fields to a document, identified by a document ID and a list of field details."],["It includes methods for date serialization and deserialization, as well as calculating the millisecond epoch time for dates or datetimes."],["The module also features tools to locate and return specific fields within a document, either individually or all instances of a field name."],["The module includes methods for converting text to the NKFD format, and removing accents from text as well as generating a string representation of an ANTLR parse tree."]]],[]]
