Package pyctags :: Module harvesters :: Class name_lookup_harvester
[hide private]
[frames] | no frames]

Class name_lookup_harvester

source code

base_harvester --+
                 |
                name_lookup_harvester

Builds a sorted list of unique tag names.

Instance Methods [hide private]
 
__init__(self) source code
 
__len__(self)
Number of unique tag names found.
source code
 
feed(self, entry)
Records unique names.
source code
 
do_after(self)
Process the unique names into a form easier to query.
source code
list
starts_with(self, matchstr, **kwargs)
Fetches an alphabetical list of unique tag names that begin with matchstr.
source code

Inherited from base_harvester: do_before, get_data, process_tag_list

Method Details [hide private]

feed(self, entry)

source code 

Records unique names.

Parameters:
  • entry (ctags_entry) - the entry to collect the name from.
Overrides: base_harvester.feed

do_after(self)

source code 

Process the unique names into a form easier to query.

Overrides: base_harvester.do_after

starts_with(self, matchstr, **kwargs)

source code 

Fetches an alphabetical list of unique tag names that begin with matchstr.

  • Parameters:
    • matchstr: (str) string to search for in tags db
  • Keyword Arguments:
    • num_results: (int) maximum number of results to return, 0 for all, default
    • case_sensitive: (bool) whether to match case, default False
Returns: list
matching tag names