rephorm 1.0.1__py3-none-any.whl

rephorm/object_mappers/table_mapper.py

@@ -0,0 +1,191 @@
+from fpdf import FontFace
+
+from rephorm.object_mappers._utilities.table_mapper_utility import (
+    get_max_numerical_width,
+    get_max_width,
+)
+from rephorm.utility.report.add_footnotes import add_footnotes_at_bottom
+from rephorm.utility.report.footnotes_counter import generate_footnote_numbers
+from rephorm.utility.report.report_utility import get_page_dimensions
+from rephorm.utility.report.resolve_color import resolve_color
+from rephorm.utility.report.title_utility import add_title_with_references
+
+
+class TableMapper:
+    def __init__(self, table):
+        self.table = table
+
+    def add_to_pdf(self, **kwargs):
+
+        pdf = kwargs["pdf"]
+        highlight = []
+        x = kwargs["x"]
+        w = kwargs["w"]
+        h = kwargs["h"]
+        y = kwargs["y"]
+
+        title_bottom_padding = self.table.settings.styles["report"]["title_bottom_padding"]
+        #Todo: Consider extracting context based on caller. So we do not need to deal with string checks. Discuss with Sergey.
+        context = kwargs.get("context", None)
+        custom_width = self.table.width
+        footer_top_padding = self.table.settings.styles["report"]["footer"]["top_padding"]
+        footer_top_margin = self.table.settings.styles["report"]["footer"]["top_margin"]
+        footer_last_y = kwargs["footer_last_y"] if "footer_last_y" in kwargs else None
+
+        # Todo: Consider replacing (full_width_grid) conditional based on grid row settings? if nrow and ncol = 1? Talk to Sergey why
+        full_width_grid = (w == pdf.epw)
+        is_multi_cell_grid = context == "grid" and not full_width_grid
+
+        skip_cols = 1
+        headers = [""]
+
+        pdf.set_xy(x, y)
+        page_width, _ = get_page_dimensions(pdf)
+
+        num_col_width = get_max_numerical_width(
+            self.table,
+            pdf,
+            font_family=self.table.settings.styles["table"]["series"]["font_family"],
+            font_size=self.table.settings.styles["table"]["series"]["font_size"],
+            biggest_nr="10000",
+        )
+
+        title_col_width = get_max_width(
+            self.table,
+            pdf,
+            font_family=self.table.settings.styles["table"]["series"]["font_family"],
+            font_size=self.table.settings.styles["table"]["series"]["font_size"],
+            parameter="title",
+            max_width=0,
+        )
+        unit_col_width = get_max_width(
+            self.table,
+            pdf,
+            font_family=self.table.settings.styles["table"]["series"]["font_family"],
+            font_size=self.table.settings.styles["table"]["series"]["font_size"],
+            parameter="unit",
+            max_width=0,
+        )
+
+        if self.table.settings.highlight is not None:
+            highlight = self.table._get_table_highlight()
+
+        span = self.table._get_span()
+
+        if self.table.settings.show_units:
+            skip_cols += 1
+
+        if self.table.settings.show_units:
+            headers = headers + ["Units"]
+
+        heading_data = [
+            headers + list(span.to_compact_strings()),
+        ]
+
+        heading = heading_data[0][skip_cols:]
+
+        num_col_padding = 10
+
+        col_widths = (
+            [
+                title_col_width + 10
+            ]  # TODO: first column width | We introduce param for this. the name of param: title_col_width
+            + [unit_col_width + 0]
+            * self.table.settings.show_units  # TODO: second column width | We introduce param for this. the name of param: unit_col_width
+            + [num_col_width + num_col_padding] * len(heading)  # numerical columns width
+        )
+
+        # we use effective page width here (excluding margins)
+        page_width = pdf.epw
+
+        natural_table_width = sum(col_widths) + 10
+
+        if natural_table_width > page_width:
+            table_width = page_width
+        else:
+            if is_multi_cell_grid:
+                table_width = w
+            else:
+                table_width = natural_table_width
+
+        text_align = ["L"] * skip_cols + ["R"] * len(heading)
+
+        h_data = headers + heading
+
+        # ----------------- Set Table Title -----------------
+
+        footnote_references = generate_footnote_numbers(self.table.footnotes)
+        y = add_title_with_references(
+            pdf=pdf,
+            title=self.table.title,
+            references=footnote_references,
+            font_family=self.table.settings.styles["table"]["title"]["font_family"],
+            font_size=self.table.settings.styles["table"]["title"]["font_size"],
+            font_style=self.table.settings.styles["table"]["title"]["font_style"],
+            title_y=y,
+            cell_width=w,
+        )
+        if bool(self.table.footnotes):
+            footer_last_y = add_footnotes_at_bottom(
+                pdf,
+                self.table.footnotes,
+                footnote_references,
+                last_y=footer_last_y,
+                font_family=self.table.settings.styles["footnotes"]["font_family"],
+                font_size=self.table.settings.styles["footnotes"]["font_size"],
+                font_style=self.table.settings.styles["footnotes"]["font_style"],
+                footer_padding=footer_top_padding,
+                footer_top_margin=footer_top_margin,
+            )
+
+        # Todo: Consider: title padding could be part of add_title_with_ref function, so we only pass here Y after calling that func)
+        pdf.set_y(y + title_bottom_padding)
+
+        # ----------------- Set Table Header -----------------
+        with pdf.table(
+            width=custom_width if custom_width else table_width,
+            col_widths=col_widths,
+            text_align=text_align,
+            align="l" if is_multi_cell_grid else "c",
+            # TODO: ADD border settings to styles for table
+            borders_layout="SINGLE_TOP_LINE",
+            # line height sets the height of rows, 1,4 is multiplier. (We cannot precisely extract height of the text)
+            # Todo: Consider extracting this to param/styles, like inrow_offset...
+            line_height=self.table.settings.styles["table"]["series"]["font_size"]
+            * 1.4,
+        ) as pdf_table:
+
+            heading_row = pdf_table.row()
+            header_color = resolve_color(
+                self.table.settings.styles["table"]["heading"]["highlight_color"]
+            )
+
+            for i, header in enumerate(h_data):
+                # Todo: Remove Grey and etc params from table object and move them to styles
+                style = FontFace(
+                    emphasis=self.table.settings.styles["table"]["heading"][
+                        "font_style"
+                    ],
+                    size_pt=self.table.settings.styles["table"]["heading"]["font_size"],
+                    fill_color=header_color if i in highlight else "#FFFFFF00",
+                    family=self.table.settings.styles["table"]["heading"][
+                        "font_family"
+                    ],
+                    color=resolve_color(
+                        self.table.settings.styles["table"]["heading"]["font_color"]
+                    ),
+                )
+
+                heading_row.cell(header, style=style)
+
+            # ----------------- Set Table Rows -----------------
+            for item in self.table.CHILDREN:
+                mapper = item._get_mapper()
+                mapper.add_to_pdf(
+                    span=span,
+                    pdf_table=pdf_table,
+                    highlight=highlight,
+                    n_cols=len(col_widths),
+                    show_units=self.table.settings.show_units,
+                    footer_last_y=footer_last_y,
+                )

rephorm/object_mappers/table_section_mapper.py

@@ -0,0 +1,41 @@
+from fpdf import FontFace
+from rephorm.utility.report.resolve_color import resolve_color
+
+class TableSectionMapper:
+    def __init__(self, table_section):
+        self.table_section = table_section
+
+    def add_to_pdf(self, **kwargs):
+
+        n_cols = kwargs["n_cols"]
+        highlight = kwargs["highlight"]
+        pdf_table = kwargs["pdf_table"]
+        span = kwargs["span"]
+        title_row = pdf_table.row()
+
+
+        for i in range(n_cols):
+
+            color = resolve_color(self.table_section.settings.styles["table"]["section"]["highlight_color"])
+
+            style = FontFace(
+                emphasis= self.table_section.settings.styles["table"]["section"]["font_style"],
+                size_pt=self.table_section.settings.styles["table"]["section"]["font_size"],
+                fill_color= color if i in highlight else "#FFFFFF00",
+                family=self.table_section.settings.styles["table"]["section"]["font_family"],
+                color=self.table_section.settings.styles["table"]["section"]["font_color"],
+            )
+
+            content = self.table_section.TITLE if i == 0 else ""
+            title_row.cell(content, style=style)
+
+        for item in self.table_section.CHILDREN:
+            mapper = item._get_mapper()
+            mapper.add_to_pdf(span=span, pdf_table=pdf_table, highlight=highlight, show_units=self.table_section.settings.show_units)
+
+
+
+
+
+
+

rephorm/object_mappers/table_series_mapper.py

@@ -0,0 +1,79 @@
+
+from fpdf import FontFace
+
+from rephorm.utility.report.resolve_color import resolve_color
+from rephorm.utility.report.table_utility import prepare_row
+
+
+class TableSeriesMapper:
+    def __init__(self, series):
+        self.series = series
+
+    def add_to_pdf(self, **kwargs):
+
+
+        highlight = kwargs["highlight"]
+        pdf_table = kwargs["pdf_table"]
+        span = kwargs["span"]
+        show_units = kwargs["show_units"]
+        #fpdf = kwargs["fpdf"]#todo: add to kwargs
+        # last_y = kwargs["footer_last_y"] # We get last Y from parent,
+        # so to add footnote to the bottom of the page right after parent footnotes.
+
+        # Get start page nr before adding row
+        # start_page_nr = fpdf.page_no()
+
+        # add row
+        element_row = pdf_table.row()
+
+        #get page number after adding row
+        # current_page_nr = fpdf.page_no()
+
+        # In case the first element is on the next page, we need to reset last_y to none,
+        # so that the add_footnotes_at_bottom function recalculates footnote positions
+        # if current_page_nr > start_page_nr:
+        #     last_y = None
+
+        #Gen references here, pass it down to prep row and later to add_footnotes_. ...
+        # footnote_references = generate_footnote_numbers(self.series.footnotes)
+
+        row = prepare_row(
+            series=self.series,
+            compare_style=self.series.settings.compare_style,
+            span=span,
+            show_units=show_units,
+            unit=self.series.unit,
+            title=self.series.title,
+            decimal_precision=self.series.settings.decimal_precision,
+            footnote_references=None, # Todo: footnote_references
+        )
+
+        # add_footnotes_at_bottom(footnotes=self.series.footnotes,
+        #     last_y=last_y,)
+
+        color = resolve_color(self.series.settings.styles["table"]["series"]["highlight_color"])
+
+        # I think we use similar logic in couple places, look if it's the case and put in utility.
+        for i, cell in enumerate(row):  # Process each cell in the row
+
+            style = FontFace(
+                family=self.series.settings.styles["table"]["series"]["font_family"],
+                emphasis=self.series.settings.styles["table"]["series"]["font_style"],
+                size_pt=self.series.settings.styles["table"]["series"]["font_size"],
+                fill_color= color if i in highlight else "#FFFFFF00",
+                color=resolve_color(self.series.settings.styles["table"]["series"]["font_color"]),
+            )
+
+            # ^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+            if self.series.settings.comparison_series:
+                padding = (-self.series.settings.styles["table"]["series"]["font_size"]*0.6, 0, 5, 0)
+                style.size_pt *= 0.8 # Sets size of comparison series
+            else:
+                padding = (0, 0, 0, 0)
+
+            element_row.cell(
+                cell,
+                style=style,
+                padding = padding,
+            )

rephorm/object_mappers/text_mapper.py

@@ -0,0 +1,36 @@
+from rephorm.utility.report.title_utility import add_title_with_references
+
+
+class TextMapper:
+    def __init__(self, text):
+        self.text = text
+
+    def add_to_pdf(self, **kwargs):
+        pdf = kwargs["pdf"]
+        w = kwargs["w"]
+        y = kwargs["y"]
+        x = kwargs["x"]
+
+        family = self.text.settings.styles["text"]["title"]["font_family"]
+        size = self.text.settings.styles["text"]["title"]["font_size"]
+        style = self.text.settings.styles["text"]["title"]["font_style"]
+
+        # todo: check multipliers everywhere and use line height const for it.
+        line_height = 1.5 # todo: consider extracting to styles, once again.
+
+        y = add_title_with_references(pdf=pdf, title=self.text.title, references=None,
+                                  font_family=family, font_size=size, font_style=style, title_y=y)
+
+        pdf.set_font(family=self.text.settings.styles["text"]["font_family"],
+                     size=self.text.settings.styles["text"]["font_size"],
+                     style=self.text.settings.styles["text"]["font_style"])
+
+        pdf.set_xy(x, y)
+
+        pdf.multi_cell(
+            w=w,
+            h=self.text.settings.styles["text"]["font_size"] * line_height,
+            txt=self.text.TEXT,
+            align=self.text.align,
+            markdown=self.text.markdown,
+        )

rephorm/object_params/settings.py

@@ -0,0 +1,184 @@
+from typing import Dict
+import irispie as ir
+
+from rephorm.dict.styles import default_styles
+
+"""
+    This Dictionary defines all possible parameters that can be applied to any object within the report.
+    
+    - default_value - default value of the parameter
+    - type - for type checking | if type is None, then it is not being checked ("useful" in case of Complex data Types)
+    - ultimates - list of objects that should get/receive this parameter
+"""
+
+object_params = {
+    "span": {
+        "default_value": ir.start >> ir.end,
+        "type": ir.Span,
+        "ultimates": ["Chart", "Table", "ChartSeries", "TableSeries"],
+    },
+    "highlight" : {
+        "default_value": None,
+        "type": ir.Span,
+        "ultimates": ["Chart", "Table", "TableSection", "TableSeries"],
+    },
+    "show_legend" : {
+        "default_value": True,
+        "type": bool,
+        "ultimates": ["ChartSeries"],
+    },
+    "yaxis": {
+        "default_value": "left",
+        "type": str,
+        "possible_values":
+                    {"left", "right"},
+        "ultimates": ["ChartSeries"],
+    },
+    "update_traces" : { # todo: check if this is used
+        "default_value": None,
+        "type": Dict,
+        "ultimates": ["ChartSeries"],
+    },
+    "show_grid" : {
+        "default_value": True,
+        "type": bool,
+        "ultimates": ["Chart"],
+    },
+    "axis_border" : {
+        "default_value": False,
+        "type": bool,
+        "ultimates": ["Chart"],
+    },
+    "xaxis_title" : {
+        "default_value": "",
+        "type": str,
+        "ultimates": ["Chart"],
+    },
+    "yaxis_title" : {
+        "default_value": "",
+        "type": str,
+        "ultimates": ["Chart"],
+    },
+    "yaxis2_title" : {
+        "default_value": "",
+        "type": str,
+        "ultimates": ["Chart"],
+    },
+    "legend_orientation" : {
+        "default_value": "h",
+        "type": str,
+        "ultimates": ["Chart"],
+    },
+    "legend_position" : {
+        "default_value": "SO",
+        "type": str,
+        "possible_values":
+            {"N", "S", "E", "W",
+            "NE", "NW", "SE", "SW",
+            "NO", "SO", "EO", "WO",
+            "NEO", "NWO", "SEO", "SWO"},
+        "ultimates": ["Chart"],
+    },
+    "ncol" : {
+        "default_value": 2,
+        "type": int,
+        "ultimates": ["Grid"],
+    },
+    "nrow" : {
+        "default_value": 2,
+        "type": int,
+        "ultimates": ["Grid"],
+    },
+    "apply_report_layout": {
+        "default_value": False,
+        "type": bool,
+        "ultimates": ["Chart"],
+    },
+    "layout": {
+        "default_value": None,
+        "type": None,
+        "ultimates": ["Grid"],
+    },
+    "comparison_series" : {
+        "default_value": False,
+        "type": bool,
+        "ultimates": ["TableSeries"],
+    },
+    "series_type" : {
+        "default_value": "line",
+        "type": str,
+        "possible_values": {"line", "bar", "contribution_bar", "barcon", "conbar", "bar_stack", "bar_group", "bar_overlay", "bar_relative"},
+        "ultimates": ["Chart", "ChartSeries"],
+    },
+    "markers_mode" : {
+        "default_value": "lines",
+        "type": str,
+        "possible_values": {"lines+markers", "lines", "markers"},
+        "ultimates": ["ChartSeries"], # TEST IT: Chart was removed as Chart should not use it in any way
+    },
+    "legend" : {
+        "default_value": None,
+        "type": tuple,
+        "ultimates": ["Chart", "ChartSeries"],
+    },
+    "compare_style" : {
+        "default_value": "",
+        "type": str,
+        "ultimates": ["TableSeries"],
+    },
+    "marker_symbol" : {
+        "default_value": "asterisk",
+        "type": str,
+        "ultimates": ["Chart", "ChartSeries"],
+    },
+    "orientation" : {
+        "default_value": "P",
+        "type": str,
+        "ultimates": ["Report"],
+    },
+    "unit" : {
+        "default_value": "pt",
+        "type": str,
+        "ultimates": ["Report"],
+    },
+    "format" : {
+        "default_value": "A4",
+        "type": str,
+        "ultimates": ["Report"],
+    },
+    "decimal_precision" : {
+        "default_value": 1,
+        "type": int,
+        "ultimates": ["TableSeries"],
+    },
+    "show_units" : {
+        "default_value": True,
+        "type": bool,
+        "ultimates": ["TableSection", "Table"],
+    },
+    "zeroline" : {
+        "default_value": False,
+        "type": bool,
+        "ultimates": ["Chart"],
+    },
+    "legend_ncol" : {
+        "default_value": None,
+        "type": int,
+        "ultimates": ["Chart"],
+    },
+    "frequency" : {
+        "default_value": None,
+        "type": None, #Cant check this one
+        "ultimates": ["Table"],
+    },
+    "styles": {
+        "default_value": default_styles(),
+        "type": None, # TODO: change to Dict later on
+        "ultimates": ["Report", "Chapter", "TableSection", "ChartSeries", "TableSeries", "Table", "Chart", "Grid", "Text"],
+    },
+    "logo": {
+        "default_value": "",
+        "type": str,
+        "ultimates": ["Report"],
+    }
+}

rephorm/objects/_utilities/settings_container.py

@@ -0,0 +1,8 @@
+"""
+Generic settings container.
+Encapsulates all settings for a specific object.
+"""
+class SettingsContainer:
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+            setattr(self, key, value)

rephorm/objects/chapter.py

@@ -0,0 +1,44 @@
+import copy
+from typing import Optional, Union, List
+
+from rephorm.object_mappers.chapter_mapper import ChapterMapper
+from rephorm.objects.chart import Chart
+from rephorm.objects.page_break import PageBreak
+from rephorm.objects.grid import Grid
+from rephorm.objects._utilities.settings_container import SettingsContainer
+from rephorm.objects.table import Table
+from rephorm.objects.text import Text
+from rephorm.decorators.settings_validation import validate_kwargs
+from rephorm.utility.add_style_prefix import add_prefix_to_styles
+
+
+class Chapter:
+    @validate_kwargs
+    def __init__(self, title: str = None, footnotes: Optional[List[str]] = None, **kwargs):
+        """
+            :param title: (str) Title of the chapter.
+            :key styles (Dict): Styles dictionary for additional customization (for details refer to report object).
+        """
+        self.title = title
+        self.footnotes = footnotes
+        self.CHILDREN = []
+        # if "styles" in kwargs:
+        #     kwargs["styles"]=adjust_styles(kwargs["styles"], caller)
+        self.settings = SettingsContainer(**kwargs)
+        if hasattr(self.settings, "styles"):
+            self.settings.styles = add_prefix_to_styles("chapter", self.settings.styles)
+
+    def add(
+        self,
+        chapter_child: Union[Grid, Table, Text, PageBreak, Chart] = None,
+    ):
+        if chapter_child is not None and isinstance(chapter_child, (Grid, Table, Text, PageBreak, Chart)):
+            copy_chapter_child = copy.deepcopy(chapter_child)
+            self.CHILDREN.append(copy_chapter_child)
+        else: raise Exception("Chapter: chapter child of wrong type or None")
+
+    def _get_mapper(self):
+        return ChapterMapper(self)
+
+    def __repr__(self):
+        return f"{type(self).__name__}"

rephorm/objects/chart.py

@@ -0,0 +1,70 @@
+import copy
+import plotly
+from rephorm.object_mappers.chart_mapper import ChartMapper
+from rephorm.objects.chart_series import ChartSeries
+from rephorm.objects._utilities.settings_container import SettingsContainer
+from rephorm.utility.add_style_prefix import add_prefix_to_styles
+
+from rephorm.utility.report.range_utility import get_span, get_highlight
+from rephorm.decorators.settings_validation import validate_kwargs
+
+class Chart:
+
+    @validate_kwargs
+    def __init__(self, title: str = None, figure: plotly.graph_objs.Figure = None, **kwargs):
+        """
+            :args title (str): title of the chart
+            :args figure (plotly.graph_objs.Figure): Plotly figure object. If provided, it will plot the given figure object.
+            :args span (ir.Span): Span of the chart
+            :key apply_report_layout (bool): If True, applies the standard report layout to the provided figure (can only be used for a custom Plotly figure).
+            :key highlight (ir.Span): Span of the highlight.
+            :key show_legend (bool): to show/hide the legend.
+            :key show_grid (bool): to show/hide the grid.
+            :key axis_border (bool): enable/disable axis borders.
+            :key xaxis_title (str): The title for the X-axis.
+            :key yaxis_title (str): The title for the Y-axis.
+            :key yaxis2_title (str): The title for the second Y-axis.
+            :key legend_orientation (str): legend orientation. "v" or "h".
+            :key legend_position (str): Position of the legend. e.g. "SO" - South Outside. "S" - South Inside.
+            :key series_type (str): Type of series to display - "line" for line charts, "bar" for bar charts,
+            "bar_contribution" for contribution bar charts; use "line" with markers_mode="markers" for marker-based charts.
+            :key markers_mode (str): Display style for data points - "lines+markers" (lines with symbols/dots),
+            "lines" (lines only), or "markers" (symbols/dots only).
+            :key legend (tuple): Specifies the legend labels for the series. For multivariate series, provide multiple labels like ("Label 1", "Label 2", ...).
+            :key marker_symbol (str): Symbol name for markers, default is "asterisk".
+            :key zeroline (bool): If True, displays a horizontal line at Y=0 to help indicate the zero baseline.
+            :key styles (Dict): Styles dictionary for additional customization (for details refer to report object).
+        """
+        self.CHILDREN = []
+        self.title = title
+        self.figure = figure
+        self.settings = SettingsContainer(**kwargs)
+
+        if hasattr(self.settings, "styles"):
+            self.settings.styles = add_prefix_to_styles("chart", self.settings.styles)
+
+    def add(
+            self,
+            chart_child: ChartSeries = None):
+        # Todo: add docstring later on.
+        """
+            :param chart_child: (ChartSeries) Child of the chart.
+        """
+
+        if chart_child is not None and isinstance(chart_child, ChartSeries):
+            copy_chart_child = copy.deepcopy(chart_child)
+            self.CHILDREN.append(copy_chart_child)
+
+        else: raise Exception("CHART: Chart child of wrong type or None")
+
+    def __repr__(self):
+        return f"{type(self).__name__}"
+
+    def _get_mapper(self):
+        return ChartMapper(self)
+
+    def _get_span(self):
+        return get_span(self)
+
+    def _get_highlight(self):
+        return get_highlight(self)