textX-jinja 0.3.0

Description:

textXjinja 0.3.0

textX-jinja
Jinja based framework for
textX generators. Use if you need to generate a
set of template-based files from textX models.
How to use?


Create a folder containing files and folder which resemble the structure you
want to generate. Each file may be a Jinja template (should end with .jinja
extension).


File names may contain variable parts in the form __<varible name>__
(double underscores around the variable name). These parts of file names will
be replaced by the value of the variable from the generator context. If the
variable is iterable, a file will be created for each object. In that case,
the value for substitution in the file name will be created by function
map_names(still WIP!), if given, or str of the object itself. The object
will be available in the template context under the name obj. If the
variable is of bool type the file will be skipped if the variable value is
False.


In your textX project register a generator (see
registration).
from textx import generator
from textxjinja import textx_jinja_generator

@generator('mylang', 'mytarget')
def mygenerator(metamodel, model, output_path, overwrite, debug):
# template directory
template_folder = os.path.join(os.path.dirname(__file__), 'templates')

# create context dict with all variables that should be accessible
# by templates
context = {'some_variable': 'some value'}

# Optionally provide Jinja filters
def striptabs(s):
return re.sub(r'^[ \t]+', '', s, flags=re.M)
filters = {
'striptabs': striptabs
}

# call the generator
textx_jinja_generator(template_folder, output_path, context, overwrite, filters)



Install your project (recommended is the usage of Python virtual environment):
pip install -e <path to your project>



Run your textX generator as usual:
$ textx generate ...



The generator will use the template folder for rendering files using Jinja
template engine. All files from the template folder which are not Jinja
templates (don't end with .jinja' extensions) will be copied over to the
target folder unchanged (variable substitutions in file names still apply).
As a full example of its usage see startproject generator in textX-dev
project.
Templates for the startproject command are here.