Module ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad body Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr BoolOpOr NameLoad Dict Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults Num Num NameLoad Str NameLoad body Expr Str Assign NameStore Dict If NameLoad body Assign SubscriptStore NameLoad Index Str NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore NameLoad Index Str NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore NameLoad Index Str NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore NameLoad Index Str NameLoad Assign SubscriptStore NameLoad Index Str NameLoad Assign SubscriptStore AttributeLoad NameLoad attr Index NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Dict If AttributeLoad NameLoad attr body Assign SubscriptStore NameLoad Index Str AttributeLoad NameLoad attr If AttributeLoad NameLoad attr body Assign SubscriptStore NameLoad Index Str AttributeLoad NameLoad attr If AttributeLoad NameLoad attr body Assign SubscriptStore NameLoad Index Str AttributeLoad NameLoad attr If AttributeLoad NameLoad attr body Assign SubscriptStore NameLoad Index Str AttributeLoad NameLoad attr If AttributeLoad NameLoad attr body Assign SubscriptStore NameLoad Index Str AttributeLoad NameLoad attr If AttributeLoad NameLoad attr body Assign SubscriptStore NameLoad Index Str AttributeLoad NameLoad attr If AttributeLoad NameLoad attr body Assign SubscriptStore NameLoad Index Str AttributeLoad NameLoad attr orelse Assign SubscriptStore NameLoad Index Str Dict Str Dict Return NameLoad decorator_list decorator_list
N/A HighLighter N/A object N/A N/A 
    This object manage the highlighting

    :arg pre_tags: list of tags before the highlighted text.
        importance is ordered..  ex. ``['<b>']``
    :arg post_tags: list of end tags after the highlighted text.
        should line up with pre_tags.  ex. ``['</b>']``
    :arg fields: list of fields to highlight
    :arg fragment_size: the size of the grament
    :arg number_or_fragments: the maximum number of fragments to
        return; if 0, then no fragments are returned and instead the
        entire field is returned and highlighted.
    :arg fragment_offset: controls the margin to highlight from

    Use this with a :py:class:`pyes.query.Search` like this::

        h = HighLighter(['<b>'], ['</b>'])
        s = Search(TermQuery('foo'), highlight=h)
     __init__ N/A N/A self pre_tags post_tags fields fragment_size number_of_fragments fragment_offset encoder N/A None None None None None None None N/A N/A N/A self pre_tags pre_tags N/A N/A self post_tags post_tags N/A N/A self fields N/A fields N/A N/A N/A self fragment_size fragment_size N/A N/A self number_of_fragments number_of_fragments N/A N/A self fragment_offset fragment_offset N/A N/A self encoder encoder N/A add_field N/A N/A self name fragment_size number_of_fragments fragment_offset order type N/A 150 3 None score None N/A N/A 
        Add a field to Highlinghter
         N/A data N/A N/A fragment_size N/A N/A N/A data N/A fragment_size fragment_size N/A N/A number_of_fragments None N/A N/A N/A data N/A number_of_fragments number_of_fragments N/A N/A fragment_offset None N/A N/A N/A data N/A fragment_offset fragment_offset N/A N/A type None N/A N/A N/A data N/A type type N/A N/A data N/A order order N/A N/A N/A self fields N/A name data N/A serialize N/A N/A self N/A N/A N/A res N/A N/A N/A self pre_tags N/A N/A N/A res N/A pre_tags N/A self pre_tags N/A N/A self post_tags N/A N/A N/A res N/A post_tags N/A self post_tags N/A N/A self fragment_size N/A N/A N/A res N/A fragment_size N/A self fragment_size N/A N/A self number_of_fragments N/A N/A N/A res N/A number_of_fragments N/A self number_of_fragments N/A N/A self fragment_offset N/A N/A N/A res N/A fragment_offset N/A self fragment_offset N/A N/A self encoder N/A N/A N/A res N/A encoder N/A self encoder N/A N/A self fields N/A N/A N/A res N/A fields N/A self fields N/A N/A N/A res N/A fields N/A _all N/A N/A res N/A N/A