Package pyctags :: Module tag_base :: Class ctags_base
[hide private]
[frames] | no frames]

Class ctags_base

source code

Known Subclasses:

This class exists to provide a template and some functionality for wrapping command line ctags programs.

The functions _query_tag_generator, generate_tags, and generate_tagfile should be overriden in child classes.

Instance Methods [hide private]
 
__init__(self, *args, **kwargs)
Base class to wrap ctags program.
source code
boolean
ctags_executable(self, path)
Sets ctags path and executable.
source code
 
_query_tag_generator(self, path)
Abstract method, used to test ctags generator.
source code
 
generate_tags(self, *args, **kwargs)
Abstract function to parse source files, returns list of tag strings.
source code
 
generate_tagfile(self, *args, **kwargs)
Abstract method to generate a tags file.
source code
 
input_files(self, files)
Sets the list of files to process with ctags.
source code
Instance Variables [hide private]
  _file_list
A list of file names to process.
  _executable_path
The ctags executable.
  command_line
The command line generated and used.
  warnings
A place to store warnings from ctags.
Method Details [hide private]

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

source code 

Base class to wrap ctags program.

  • Keyword Arguments:
    • tag_program: (str) path to ctags executable, or name of a ctags program in path
    • files: (sequence) files to process with ctags

ctags_executable(self, path)

source code 

Sets ctags path and executable.

Parameters:
  • path (str) - ctags executable name or path to it
Returns: boolean
executable found

_query_tag_generator(self, path)

source code 

Abstract method, used to test ctags generator.

Raises:
  • NotImplementedError - Abstract method, must be overridden.

generate_tags(self, *args, **kwargs)

source code 

Abstract function to parse source files, returns list of tag strings.

Raises:
  • NotImplementedError - Abstract method, must be overridden per ctags program

generate_tagfile(self, *args, **kwargs)

source code 

Abstract method to generate a tags file.

Raises:
  • NotImplementedError - Abstract method, must be overridden per ctags program

input_files(self, files)

source code 

Sets the list of files to process with ctags.

Parameters:
  • files (sequence) - sequence of files, relative or absolute path