"""Writer class to be used with Jinja2 templates"""
from jinja2 import Environment, FileSystemLoader
from jinja2.exceptions import TemplateNotFound, TemplateSyntaxError
from biomajmanager.utils import Utils
import os
import sys
[docs]class Writer(object):
"""Writer class for BioMAJ manager to create what's desired as output"""
[docs] def __init__(self, template_dir=None, config=None, output=None):
"""
Create Writer object
:param template_dir: Root directory where to find templates
:type template_dir: str
:param config: Global configuration file from BiomajConfig
:type config: :class:`configparser`
:param output: Output file. Default STDOUT
:type output: str
:raises SystemExit: If 'template_dir' is not given
:raises SystemExit: If 'MANAGER' section not found in :py:data:`manager.properties`
:raises SystemExit: If 'template.dir' not set in :py:data:`manager.properties`
"""
self.env = None
self.output = None
self.template_dir = None
if template_dir is not None:
if not os.path.isdir(template_dir):
Utils.error("Template dir %s is not a directory" % template_dir)
self.template_dir = template_dir
elif config is not None:
if not config.has_section('MANAGER'):
Utils.error("Configuration has no 'MANAGER' section.")
elif not config.has_option('MANAGER', 'template.dir'):
Utils.error("Configuration has no 'template.dir' key.")
else:
self.template_dir = config.get('MANAGER', 'template.dir')
if self.template_dir is None:
Utils.error("'template.dir' not set")
self.env = Environment(loader=FileSystemLoader(os.path.join(self.template_dir)),
trim_blocks=True, lstrip_blocks=True,
extensions=['jinja2.ext.with_'])
self.output = output
[docs] def write(self, template=None, data=None):
"""
Print template 'data' to stdout using template file 'template'.
'data' arg can be left None, this way method can be used to render file
from scratch
:param template: Template file name
:type template: str
:param data: Template data
:type data: dict
:return: True, throws on error
:rtype: bool
:raises SystemExit: If 'template' is None
:raises SystemExit: If 'template' is not found
:raises SystemExit: If 'template' has a syntax error in it
:raises SystemExit: If 'output' file cannot be opened
"""
if template is None:
Utils.error("A template name is required")
try:
template = self.env.get_template(template)
except TemplateNotFound as err:
Utils.error("Template %s not found in %s" % (err, self.template_dir))
except TemplateSyntaxError as err:
Utils.error("Syntax error found in template '%s', line %d: %s" % (err.name, err.lineno, err.message))
if self.output is None:
ofile = sys.stdout
else:
try:
ofile = open(self.output, 'w')
except IOError as err:
Utils.error("Can't open %s: %s" % (self.output, str(err)))
Utils._print(template.render(data), to=ofile)
return True