mirror of
https://github.com/github/codeql.git
synced 2025-12-17 09:13:20 +01:00
49 lines
1.6 KiB
Python
49 lines
1.6 KiB
Python
""" template renderer module, wrapping around `pystache.Renderer`
|
|
|
|
`pystache` is a python mustache engine, and mustache is a template language. More information on
|
|
|
|
https://mustache.github.io/
|
|
"""
|
|
|
|
import logging
|
|
import pathlib
|
|
|
|
import pystache
|
|
|
|
from . import paths
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class Renderer:
|
|
""" Template renderer using mustache templates in the `templates` directory """
|
|
|
|
def __init__(self, generator):
|
|
self._r = pystache.Renderer(search_dirs=str(paths.templates_dir), escape=lambda u: u)
|
|
self.written = set()
|
|
self._generator = generator
|
|
|
|
def render(self, data, output: pathlib.Path):
|
|
""" Render `data` to `output`.
|
|
|
|
`data` must have a `template` attribute denoting which template to use from the template directory.
|
|
|
|
If the file is unchanged, then no write is performed (and `done_something` remains unchanged)
|
|
|
|
If `guard_base` is provided, it must be a path at the root of `output` and a header guard will be injected in
|
|
the template based off of the relative path of `output` in `guard_base`
|
|
"""
|
|
mnemonic = type(data).__name__
|
|
output.parent.mkdir(parents=True, exist_ok=True)
|
|
data = self._r.render_name(data.template, data, generator=self._generator)
|
|
with open(output, "w") as out:
|
|
out.write(data)
|
|
log.debug(f"generated {mnemonic} {output.name}")
|
|
self.written.add(output)
|
|
|
|
def cleanup(self, existing):
|
|
""" Remove files in `existing` for which no `render` has been called """
|
|
for f in existing - self.written:
|
|
f.unlink(missing_ok=True)
|
|
log.info(f"removed {f.name}")
|