#!/usr/bin/env python3 """Prepare output and write compiled jinja2 templates.""" import os import re from functools import reduce import jinja2.exceptions import ruamel.yaml import structlog from jinja2 import Environment, FileSystemLoader from jinja2.filters import pass_eval_context from ansibledoctor.config import SingleConfig from ansibledoctor.template import Template from ansibledoctor.utils import FileUtils, sysexit_with_message class Generator: """Generate documentation from jinja2 templates.""" def __init__(self, doc_parser): self.log = structlog.get_logger() self.config = SingleConfig() self.template = Template( self.config.config.get("template.name"), self.config.config.get("template.src"), ) self._parser = doc_parser def _create_dir(self, directory): if not self.config.config["dry_run"] and not os.path.isdir(directory): try: os.makedirs(directory, exist_ok=True) self.log.info(f"Creating dir: {directory}") except FileExistsError as e: sysexit_with_message(e) def _write_doc(self): files_to_overwite = [] for tf in self.template.files: doc_file = os.path.join( self.config.config.get("renderer.dest"), os.path.splitext(tf)[0] ) if os.path.isfile(doc_file): files_to_overwite.append(doc_file) header_file = self.config.config.get("renderer.include_header") role_data = self._parser.get_data() header_content = "" if bool(header_file): role_data["internal"]["append"] = True try: with open(header_file) as a: header_content = a.read() except FileNotFoundError as e: sysexit_with_message("Can not open custom header file", path=header_file, error=e) if ( len(files_to_overwite) > 0 and self.config.config.get("renderer.force_overwrite") is False and not self.config.config["dry_run"] ): files_to_overwite_string = "\n".join(files_to_overwite) prompt = f"These files will be overwritten:\n{files_to_overwite_string}".replace( "\n", "\n... " ) try: if not FileUtils.query_yes_no(f"{prompt}\nDo you want to continue?"): sysexit_with_message("Aborted...") except KeyboardInterrupt: sysexit_with_message("Aborted...") for tf in self.template.files: doc_file = os.path.join( self.config.config.get("renderer.dest"), os.path.splitext(tf)[0] ) template = os.path.join(self.template.path, tf) self.log.debug("Writing renderer output", path=doc_file, src=os.path.dirname(template)) # make sure the directory exists self._create_dir(os.path.dirname(doc_file)) if os.path.exists(template) and os.path.isfile(template): with open(template) as template: data = template.read() if data is not None: try: jenv = Environment( # nosec loader=FileSystemLoader(self.template.path), lstrip_blocks=True, trim_blocks=True, autoescape=jinja2.select_autoescape(), ) jenv.filters["to_nice_yaml"] = self._to_nice_yaml jenv.filters["to_code"] = self._to_code jenv.filters["deep_get"] = self._deep_get jenv.filters["safe_join"] = self._safe_join # keep the old name of the function to not break custom templates. jenv.filters["save_join"] = self._safe_join template_options = self.config.config.get("template.options") data = jenv.from_string(data).render( role_data, role=role_data, options=template_options ) if not self.config.config["dry_run"]: with open(doc_file, "wb") as outfile: outfile.write(header_content.encode("utf-8")) outfile.write(data.encode("utf-8")) except ( jinja2.exceptions.UndefinedError, jinja2.exceptions.TemplateSyntaxError, jinja2.exceptions.TemplateRuntimeError, ) as e: sysexit_with_message( "Jinja2 template error while loading file", path=tf, error=e ) except UnicodeEncodeError as e: sysexit_with_message("Failed to print special characters", error=e) def _to_nice_yaml(self, a, indent=4, **kw): """Make verbose, human readable yaml.""" yaml = ruamel.yaml.YAML() yaml.indent(mapping=indent, sequence=(indent * 2), offset=indent) stream = ruamel.yaml.compat.StringIO() yaml.dump(a, stream, **kw) return stream.getvalue().rstrip() def _to_code(self, a, to_multiline=False, skip_list_len=0, lang="plain"): """Wrap a string in backticks.""" if a is None or a == "": return "" if (isinstance(a, list) and len(a) < 1) or (isinstance(a, dict) and not a): return "" if isinstance(a, list) and len(a) == 1: return f"`{a[0]}`" if isinstance(a, list) and skip_list_len > 0 and len(a) > skip_list_len: return a if (isinstance(a, list)) and to_multiline: return "```" + lang + "\n" + "\n".join(a) + "\n```" return f"`{a}`" def _deep_get(self, _, dictionary, keys): default = None return reduce( lambda d, key: d.get(key, default) if isinstance(d, dict) else default, keys.split("."), dictionary, ) @pass_eval_context def _safe_join(self, eval_ctx, value, d=""): if isinstance(value, str): value = [value] normalized = jinja2.filters.do_join(eval_ctx, value, d, attribute=None) if self.config.config.renderer.autotrim: for s in [r" +(\n|\t| )", r"(\n|\t) +"]: normalized = re.sub(s, "\\1", normalized) return jinja2.filters.do_mark_safe(normalized) def render(self): self._write_doc()