Source code for robot.htmldata.htmlfilewriter

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  See the License for the specific language governing permissions and
#  limitations under the License.

import re
from abc import ABC, abstractmethod
from io import TextIOBase
from pathlib import Path

from robot.utils import HtmlWriter
from robot.version import get_full_version

from .template import HtmlTemplate

[docs] class HtmlFileWriter: def __init__(self, output: TextIOBase, model_writer: 'ModelWriter'): self.output = output self.model_writer = model_writer
[docs] def write(self, template: 'Path|str'): if not isinstance(template, Path): template = Path(template) writers = self._get_writers(template.parent) for line in HtmlTemplate(template): for writer in writers: if writer.handles(line): writer.write(line) break
def _get_writers(self, base_dir: Path): writer = HtmlWriter(self.output) return (self.model_writer, JsFileWriter(writer, base_dir), CssFileWriter(writer, base_dir), GeneratorWriter(writer), LineWriter(self.output))
[docs] class Writer(ABC): handles_line = None
[docs] def handles(self, line: str): return line.startswith(self.handles_line)
[docs] @abstractmethod def write(self, line: str): raise NotImplementedError
[docs] class ModelWriter(Writer, ABC): handles_line = '<!-- JS MODEL -->'
[docs] class LineWriter(Writer): def __init__(self, output: TextIOBase): self.output = output
[docs] def handles(self, line: str): return True
[docs] def write(self, line: str): self.output.write(line + '\n')
[docs] class GeneratorWriter(Writer): handles_line = '<meta name="Generator" content=' def __init__(self, writer: HtmlWriter): self.writer = writer
[docs] def write(self, line: str): version = get_full_version('Robot Framework') self.writer.start('meta', {'name': 'Generator', 'content': version})
[docs] class InliningWriter(Writer, ABC): def __init__(self, writer: HtmlWriter, base_dir: Path): self.writer = writer self.base_dir = base_dir
[docs] def inline_file(self, path: 'Path|str', tag: str, attrs: dict): self.writer.start(tag, attrs) for line in HtmlTemplate(self.base_dir / path): self.writer.content(line, escape=False, newline=True) self.writer.end(tag)
[docs] class JsFileWriter(InliningWriter): handles_line = '<script type="text/javascript" src='
[docs] def write(self, line: str): src ='src="([^"]+)"', line).group(1) self.inline_file(src, 'script', {'type': 'text/javascript'})
[docs] class CssFileWriter(InliningWriter): handles_line = '<link rel="stylesheet"'
[docs] def write(self, line: str): href, media ='href="([^"]+)" media="([^"]+)"', line).groups() self.inline_file(href, 'style', {'media': media})