pipen_report

package

</>

Report generation system for pipen

module

</>

Report generation system for pipen

Classes

module

</>

Provide a command line interface for the pipen_report plugin

Classes

module

</>

Provides pipen and pipen-report versions

module

</>

Filters for pipen-report

This module contains the filters for pipen-report. The filters are used in the report template to render the report.

Functions

datatable(path, *args, ncols, nrows, double_precision, excluded, **kwargs) (str) — Read data from a file, using pandas.read_csv() and make it to json sojs can handle it and render it with </>
register_component(kind, *aliases) (Callable) — Register a component renderer</>
register_ui(kind, *aliases) (Callable) — Register a UI renderer</>
render_component(component, job, level) (str) — Render the content based on its kind.</>
render_job(job, report_file, h) (str) — Generate a report template from a report json file</>
render_ui(contents, ui, job, level) (str) — Render a ui</>

module

</>

Provides preprocess

Attributes

TAG_ATTR_RE — ,re.VERBOSE | re.DOTALL )
def _preprocess_slash_h( source: str, index: int, page: int, kind: str, text: str | None = None, ) -> Tuple[str, Mapping[str, Any]]: """Preprocess headings (h1 or h2 tag) adding anchor links
Add an anchor link after the tag and produce the toc dict
For example, if the source is <h1>Title 1</h1>, the output will be <h1>Title 1</h1><a id="prt-h1-1-title-1" class="pipen-report-toc-anchor"> </a>
Args: text: The string repr of the tag (e.g <h1>Title 1</h1>) index: The index of this kind of heading in the document page: Which page are we on? kind: h1 or h2

Functions

preprocess(text, basedir, toc_switch, paging, relpath_tags) (list of str, list of ) — Preprocess the rendered report and return the toc dict</>