Skip to main content

textX generator framework based on Jinja template engine

Project description

Build status Code test coverage Documentation Status

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?

  1. 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).

  2. 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, if given, or str of the object itself. The object will be available in the template under the name obj(support for iterables is still WIP!). If the variable is of bool type the file will be skipped if the variable value is False.

  3. 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 config dict with all variables that should be accessible
        # by templates
        config = {'some_variable': 'some value'}
    
        # call the generator
        textx_jinja_generator(template_folder, output_path, config, overwrite)
    
  4. Install your project (recommended is the usage of Python virtual environment):

    pip install -e <path to your project>
    
  5. 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for textX-jinja, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size textX_jinja-0.1.0-py2.py3-none-any.whl (4.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size textX-jinja-0.1.0.tar.gz (4.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page