Package pyctags :: Module tag_entry :: Class ctags_entry
[hide private]
[frames] | no frames]

Class ctags_entry

source code

An entry in the tag file.

Instance Methods [hide private]
 
__init__(self, *args, **kwargs)
A tag entry from ctags file.
source code
 
__repr__(self) source code
 
__str__(self) source code
 
__eq__(self, other) source code
 
__ne__(self, other) source code
Instance Variables [hide private]
  name
Tag name.
  file
Source file of tag.
  pattern
If not None, regular expression to locate this tag in self.file.
  line_number
If not None, line number to locate this tag in self.file.
  extensions
If not none, dict of extension fields embedded in comments in the tag entry, from exuberant ctags.
Method Details [hide private]

__init__(self, *args, **kwargs)
(Constructor)

source code 

A tag entry from ctags file. Initializes from str or keyword args.

  • Optional Parameters:
    • args[0]: (str) a ctags_entry repr or string from a tag file
  • Keyword Arguments:
    • name: (str) tag name
    • file: (str) source file name
    • pattern: (str) locator pattern for tag
    • line_number: (int) locator line number
    • extensions: (dict) extension fields
  • Raises:
    • ValueError: line_number or pattern isn't set, or a parameter type can't be transformed.