diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/ee/doit.py | 46 | ||||
| -rw-r--r-- | src/ee/ds/__init__.py | 9 | ||||
| -rw-r--r-- | src/ee/report/__init__.py | 0 | ||||
| -rw-r--r-- | src/ee/report/doit.py | 61 | ||||
| -rw-r--r-- | src/ee/report/templates/index.rst.j2 | 4 | ||||
| -rw-r--r-- | src/ee/report/templates/messages.rst.j2 | 8 |
6 files changed, 122 insertions, 6 deletions
diff --git a/src/ee/doit.py b/src/ee/doit.py index a89fdf7..665f039 100644 --- a/src/ee/doit.py +++ b/src/ee/doit.py @@ -1,9 +1,12 @@ import logging +from typing import Tuple, List, Mapping, Any from doit import get_var from ee.ds import DataSetManager +logger = logging.getLogger(__name__) + def configure_logging(): log_level = get_var("log-level", None) @@ -18,20 +21,55 @@ def configure_logging(): ee_logger.setLevel(log_level) +class Report(object): + def __init__(self, task): + self.task = task + + +class ReportCollection(object): + def __init__(self): + self._reports = [] # type: List[Report] + + def add_report(self, report: Report): + self._reports.append(report) + + @property + def reports(self) -> Tuple[Report]: + return tuple(self._reports) + + +# This should probably be called "DoItModuleConfig" since it is used once per module. The module is responsible for +# instantiating it. class DoItConfig(object): def __init__(self): self._dsm = None # type: DataSetManager + self._report_collection = None # type: ReportCollection + self._extra_config = None # type: Mapping[str, Any] self._data_sets = {} + self._reports = [] - def configure(self, *, data_set_manager: DataSetManager): + def configure(self, *, data_set_manager: DataSetManager, report_collection: ReportCollection = None, + extra_config: Mapping[str, Any] = None): self._dsm = data_set_manager + self._report_collection = report_collection if report_collection is not None else {} + self._extra_config = extra_config @property - def dsm(self): - if not self._dsm: - raise Exception("The DataSetManager has not been set") + def dsm(self) -> DataSetManager: + if self._dsm is None: + raise Exception("The data set manager has not been set") return self._dsm + @property + def report_collection(self): + if self._report_collection is None: + raise Exception("The report collection has not been set") + return self._report_collection + + @property + def extra_config(self): + return self._extra_config + def data_sets_for(self, task): try: return self._data_sets[task] diff --git a/src/ee/ds/__init__.py b/src/ee/ds/__init__.py index e543051..915dd6f 100644 --- a/src/ee/ds/__init__.py +++ b/src/ee/ds/__init__.py @@ -270,6 +270,11 @@ class DataSetManager(object): self._basedir = Path(basedir) self._csv = {} # type: MutableMapping[str, Tuple[str, Path]] + @property + def all_data_sets(self): + datasets = [ds.name for ds in self._basedir.iterdir() if (ds / "data-set.ini").is_file()] + return list(self._csv.keys()) + datasets + def cookie_for_ds(self, ds_name) -> Path: try: return self._csv[ds_name][1] @@ -314,7 +319,7 @@ class DataSetManager(object): @staticmethod def _load_csv(object_type: str, path: Path, freeze: bool) -> DataSet: - logger.debug("Loading CSV file {}".format(path)) + # logger.debug("Loading CSV file {}".format(path)) ds = DataSet() with open(str(path), newline='') as f: @@ -334,7 +339,7 @@ class DataSetManager(object): if freeze: ds.freeze() - logger.debug("Loaded {} objects".format(len(ds))) + # logger.debug("Loaded {} objects".format(len(ds))) return ds def _load_ini_dir(self, _path: str, freeze: bool) -> DataSet: diff --git a/src/ee/report/__init__.py b/src/ee/report/__init__.py new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/src/ee/report/__init__.py diff --git a/src/ee/report/doit.py b/src/ee/report/doit.py new file mode 100644 index 0000000..5d28ed4 --- /dev/null +++ b/src/ee/report/doit.py @@ -0,0 +1,61 @@ +import logging +from pathlib import Path + +from jinja2 import Environment, PackageLoader, select_autoescape + +from ee.doit import DoItConfig, Report + +logger = logging.getLogger(__name__) + +doit_config = DoItConfig() + + +def _create_env(): + return Environment( + loader=PackageLoader("ee.report.doit", "templates"), + autoescape=select_autoescape(["html", "xml"]) + ) + + +def task_report_messages(): + doit_config.report_collection.add_report(Report(task_report_messages)) + + def action(): + logger.debug("Generating messages report") + + data_sets = doit_config.dsm.all_data_sets + + logger.debug("Loading {} data sets".format(len(data_sets))) + + ds = doit_config.dsm.load_data_sets(data_sets) + + messages = [o for o in ds.items() if o.object_type.name == "message"] + logger.debug("Found {} messages".format(len(messages))) + + report_dir = Path(doit_config.extra_config["report_dir"]) + report_dir.mkdir(exist_ok=True) + + with open(report_dir / "messages.rst", "w") as f: + env = _create_env() + template = env.get_template("messages.rst.j2") + f.write(template.render(messages=messages)) + + return { + "actions": [action] + } + + +def task_make_reports(): + def action(): + report_dir = Path(doit_config.extra_config["report_dir"]) + report_dir.mkdir(exist_ok=True) + + with open(report_dir / "index.rst", "w") as f: + env = _create_env() + template = env.get_template("index.rst.j2") + f.write(template.render()) + + return { + "actions": [action], + "task_dep": [r.task.__name__[5:] for r in doit_config.report_collection.reports] + } diff --git a/src/ee/report/templates/index.rst.j2 b/src/ee/report/templates/index.rst.j2 new file mode 100644 index 0000000..5eaf939 --- /dev/null +++ b/src/ee/report/templates/index.rst.j2 @@ -0,0 +1,4 @@ +Reports +======= + +* :doc:`messages` diff --git a/src/ee/report/templates/messages.rst.j2 b/src/ee/report/templates/messages.rst.j2 new file mode 100644 index 0000000..ca08c04 --- /dev/null +++ b/src/ee/report/templates/messages.rst.j2 @@ -0,0 +1,8 @@ +Messages +======== + +There are {{ messages|count }} messages. + +{% for m in messages %} + Message: {{ m.level }} +{% endfor %} |