pkg.AbstractPkg Class Reference

Inheritance diagram for pkg.AbstractPkg:

Public Member Functions
def	__init__
def	generate
def	get_kwds
def	parse_etags
def	print_etags
def	print_tags
def	tmpl_etags
def	tmpl_tags
def	write

Public Attributes
	author
	config
	date
	debug
	not_in_dir
	pname
	tdir
	tmpl
	working_dir

Detailed Description

AbstractPkg takes care how to generate code from template/PKG
package area. The PKG can be any directory which may include
any types of files, e.g. C++ (.cc), python (.py), etc.
This class relies on specific logic which we outline here:

    - each template may use tags defined with double underscores
      enclosure, e.g. __class__, __record__, etc.
    - each template may have example tags, such tags should
      start with @example_. While processing template user may
      choose to strip them off or keep the code behind those tags
    - in addition user may specify pure python code which can
      operate with user defined tags. This code snipped should
      be enclosed with #python_begin and #python_end lines
      which declares start and end of python block

Definition at line 22 of file pkg.py.

Constructor & Destructor Documentation

def pkg.AbstractPkg.__init__	(		self,
			config = None
	)

Definition at line 39 of file pkg.py.

    def __init__(self, config=None):
        super(AbstractPkg, self).__init__()
        if  not config:
            self.config = {}
        else:
            self.config = config
        self.pname  = self.config.get('pname', None)
        self.tmpl   = self.config.get('tmpl', None)
        self.debug  = self.config.get('debug', 0)
        self.tdir   = template_directory()
        self.author = user_info(self.config.get('author', None))
        self.date   = time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime())
        self.not_in_dir = self.config.get('not_in_dir', [])
        self.working_dir = self.config.get('working_dir')