diff --git a/.isort.cfg b/.isort.cfg index 5751c40dd..f1105d854 100644 --- a/.isort.cfg +++ b/.isort.cfg @@ -9,4 +9,4 @@ line_length=88 known_odoo=odoo known_odoo_addons=odoo.addons sections=FUTURE,STDLIB,THIRDPARTY,ODOO,ODOO_ADDONS,FIRSTPARTY,LOCALFOLDER -known_third_party= +known_third_party=setuptools,xlsxwriter diff --git a/report_xlsx_helper/README.rst b/report_xlsx_helper/README.rst new file mode 100644 index 000000000..3e1dd31b0 --- /dev/null +++ b/report_xlsx_helper/README.rst @@ -0,0 +1,115 @@ +=================== +Report xlsx helpers +=================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github + :target: https://github.com/OCA/reporting-engine/tree/13.0-mig-report_xlsx_helper/report_xlsx_helper + :alt: OCA/reporting-engine +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/reporting-engine-13-0-mig-report_xlsx_helper/reporting-engine-13-0-mig-report_xlsx_helper-report_xlsx_helper + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/143/13.0-mig-report_xlsx_helper + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module provides a set of tools to facilitate the creation of excel reports with format xlsx. + +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +This module requires report_xlsx version 13.0.1.0.0 or higher. + +Usage +===== + +In order to create an Excel report you can define a report of type 'xlsx' in a static or dynamic way: + +* Static syntax: cf. ``account_move_line_report_xls`` for an example. +* Dynamic syntax: cf. ``report_xlsx_helper_demo`` for an example + +The ``AbstractReportXlsx`` class contains a number of attributes and methods to +facilitate the creation excel reports in Odoo. + +* Cell types + + string, number, boolean, datetime. + +* Cell formats + + The predefined cell formats result in a consistent + look and feel of the Odoo Excel reports. + +* Cell formulas + + Cell formulas can be easily added with the help of the ``_rowcol_to_cell()`` method. + +* Excel templates + + It is possible to define Excel templates which can be adapted + by 'inherited' modules. + Download the ``account_move_line_report_xls`` module + from http://apps.odoo.com as example. + +* Excel with multiple sheets + + Download the ``account_asset_management_xls`` module + from http://apps.odoo.com as example. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Noviat + +Contributors +~~~~~~~~~~~~ + +* Luc De Meyer +* Rattapong Chokmasermkul + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/reporting-engine `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/report_xlsx_helper/__init__.py b/report_xlsx_helper/__init__.py new file mode 100644 index 000000000..9b6fa04ee --- /dev/null +++ b/report_xlsx_helper/__init__.py @@ -0,0 +1,3 @@ +from . import controllers +from . import models +from . import report diff --git a/report_xlsx_helper/__manifest__.py b/report_xlsx_helper/__manifest__.py new file mode 100644 index 000000000..dc62b4542 --- /dev/null +++ b/report_xlsx_helper/__manifest__.py @@ -0,0 +1,13 @@ +# Copyright 2009-2019 Noviat. +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +{ + "name": "Report xlsx helpers", + "author": "Noviat, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/reporting-engine", + "category": "Reporting", + "version": "13.0.1.0.0", + "license": "AGPL-3", + "depends": ["report_xlsx"], + "installable": True, +} diff --git a/report_xlsx_helper/controllers/__init__.py b/report_xlsx_helper/controllers/__init__.py new file mode 100644 index 000000000..12a7e529b --- /dev/null +++ b/report_xlsx_helper/controllers/__init__.py @@ -0,0 +1 @@ +from . import main diff --git a/report_xlsx_helper/controllers/main.py b/report_xlsx_helper/controllers/main.py new file mode 100644 index 000000000..115832bc9 --- /dev/null +++ b/report_xlsx_helper/controllers/main.py @@ -0,0 +1,57 @@ +# Copyright 2009-2018 Noviat. +# License AGPL-3.0 or later (https://www.gnuorg/licenses/agpl.html). + +import json + +from odoo.http import content_disposition, request, route + +from odoo.addons.report_xlsx.controllers.main import ReportController + + +class ReportController(ReportController): + @route( + [ + "/report//", + "/report///", + ], + type="http", + auth="user", + website=True, + ) + def report_routes(self, reportname, docids=None, converter=None, **data): + report = request.env["ir.actions.report"]._get_report_from_name(reportname) + if converter == "xlsx" and not report: + + context = dict(request.env.context) + if docids: + docids = [int(i) for i in docids.split(",")] + if data.get("options"): + data.update(json.loads(data.pop("options"))) + if data.get("context"): + # Ignore 'lang' here, because the context in data is the one + # from the webclient *but* if the user explicitely wants to + # change the lang, this mechanism overwrites it. + data["context"] = json.loads(data["context"]) + if data["context"].get("lang"): + del data["context"]["lang"] + context.update(data["context"]) + context["report_name"] = reportname + + xlsx = report.with_context(context).render_xlsx(docids, data=data)[0] + report_file = context.get("report_file") + if not report_file: + active_model = context.get("active_model", "export") + report_file = active_model.replace(".", "_") + xlsxhttpheaders = [ + ( + "Content-Type", + "application/vnd.openxmlformats-" + "officedocument.spreadsheetml.sheet", + ), + ("Content-Length", len(xlsx)), + ("Content-Disposition", content_disposition(report_file + ".xlsx")), + ] + return request.make_response(xlsx, headers=xlsxhttpheaders) + return super(ReportController, self).report_routes( + reportname, docids, converter, **data + ) diff --git a/report_xlsx_helper/i18n/report_xlsx_helper.pot b/report_xlsx_helper/i18n/report_xlsx_helper.pot new file mode 100644 index 000000000..014fc032a --- /dev/null +++ b/report_xlsx_helper/i18n/report_xlsx_helper.pot @@ -0,0 +1,103 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * report_xlsx_helper +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 12.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: <>\n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: report_xlsx_helper +#: code:addons/report_xlsx_helper/models/ir_actions_report.py:19 +#, python-format +msgid "%s model was not found" +msgstr "" + +#. module: report_xlsx_helper +#: code:addons/report_xlsx_helper/report/report_xlsx_abstract.py:514 +#, python-format +msgid "%s, _write_line : programming error detected while processing col_specs_section %s, column %s" +msgstr "" + +#. module: report_xlsx_helper +#: code:addons/report_xlsx_helper/report/report_xlsx_abstract.py:520 +#, python-format +msgid ", cellvalue %s" +msgstr "" + +#. module: report_xlsx_helper +#: model:ir.model,name:report_xlsx_helper.model_report_report_xlsx_abstract +msgid "Abstract XLSX Report" +msgstr "" + +#. module: report_xlsx_helper +#: model:ir.model.fields,field_description:report_xlsx_helper.field_report_report_xlsx_helper_test_partner_xlsx__display_name +msgid "Display Name" +msgstr "" + +#. module: report_xlsx_helper +#: model:ir.model.fields,field_description:report_xlsx_helper.field_report_report_xlsx_helper_test_partner_xlsx__id +msgid "ID" +msgstr "" + +#. module: report_xlsx_helper +#: model:ir.model.fields,field_description:report_xlsx_helper.field_report_report_xlsx_helper_test_partner_xlsx____last_update +msgid "Last Modified on" +msgstr "" + +#. module: report_xlsx_helper +#: code:addons/report_xlsx_helper/report/report_xlsx_abstract.py:42 +#, python-format +msgid "Programming Error:\n" +"\n" +"Excel Sheet name '%s' contains unsupported special characters: '%s'." +msgstr "" + +#. module: report_xlsx_helper +#: code:addons/report_xlsx_helper/report/report_xlsx_abstract.py:36 +#, python-format +msgid "Programming Error:\n" +"\n" +"Excel Sheet name '%s' should not exceed %s characters." +msgstr "" + +#. module: report_xlsx_helper +#: code:addons/report_xlsx_helper/report/report_xlsx_abstract.py:438 +#, python-format +msgid "Programming Error:\n" +"\n" +"The '%s' column is not defined in the worksheet column specifications." +msgstr "" + +#. module: report_xlsx_helper +#: code:addons/report_xlsx_helper/report/report_xlsx_abstract.py:479 +#, python-format +msgid "Programming Error:\n" +"\n" +"The '%s' column is not defined the worksheet column specifications." +msgstr "" + +#. module: report_xlsx_helper +#: code:addons/report_xlsx_helper/report/report_xlsx_abstract.py:452 +#, python-format +msgid "Programming Error:\n" +"\n" +"The 'title' parameter is mandatory when calling the '_write_ws_title' method." +msgstr "" + +#. module: report_xlsx_helper +#: model:ir.model,name:report_xlsx_helper.model_ir_actions_report +msgid "Report Action" +msgstr "" + +#. module: report_xlsx_helper +#: model:ir.model,name:report_xlsx_helper.model_report_report_xlsx_helper_test_partner_xlsx +msgid "report.report_xlsx_helper.test_partner_xlsx" +msgstr "" + diff --git a/report_xlsx_helper/models/__init__.py b/report_xlsx_helper/models/__init__.py new file mode 100644 index 000000000..a248cf216 --- /dev/null +++ b/report_xlsx_helper/models/__init__.py @@ -0,0 +1 @@ +from . import ir_actions_report diff --git a/report_xlsx_helper/models/ir_actions_report.py b/report_xlsx_helper/models/ir_actions_report.py new file mode 100644 index 000000000..b0a12fd69 --- /dev/null +++ b/report_xlsx_helper/models/ir_actions_report.py @@ -0,0 +1,19 @@ +# Copyright 2009-2018 Noviat. +# License AGPL-3.0 or later (https://www.gnuorg/licenses/agpl.html). + +from odoo import _, api, models +from odoo.exceptions import UserError + + +class IrActionsReport(models.Model): + _inherit = "ir.actions.report" + + @api.model + def render_xlsx(self, docids, data): + if not self and self.env.context.get("report_name"): + report_model_name = "report.{}".format(self.env.context["report_name"]) + report_model = self.env.get(report_model_name) + if report_model is None: + raise UserError(_("%s model was not found" % report_model_name)) + return report_model.create_xlsx_report(docids, data) + return super(IrActionsReport, self).render_xlsx(docids, data) diff --git a/report_xlsx_helper/readme/CONTRIBUTORS.rst b/report_xlsx_helper/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..56577cc51 --- /dev/null +++ b/report_xlsx_helper/readme/CONTRIBUTORS.rst @@ -0,0 +1,2 @@ +* Luc De Meyer +* Rattapong Chokmasermkul diff --git a/report_xlsx_helper/readme/DESCRIPTION.rst b/report_xlsx_helper/readme/DESCRIPTION.rst new file mode 100644 index 000000000..4f2b52c1b --- /dev/null +++ b/report_xlsx_helper/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +This module provides a set of tools to facilitate the creation of excel reports with format xlsx. diff --git a/report_xlsx_helper/readme/INSTALL.rst b/report_xlsx_helper/readme/INSTALL.rst new file mode 100644 index 000000000..d84dece07 --- /dev/null +++ b/report_xlsx_helper/readme/INSTALL.rst @@ -0,0 +1 @@ +This module requires report_xlsx version 13.0.1.0.0 or higher. diff --git a/report_xlsx_helper/readme/USAGE.rst b/report_xlsx_helper/readme/USAGE.rst new file mode 100644 index 000000000..6efc211b4 --- /dev/null +++ b/report_xlsx_helper/readme/USAGE.rst @@ -0,0 +1,32 @@ +In order to create an Excel report you can define a report of type 'xlsx' in a static or dynamic way: + +* Static syntax: cf. ``account_move_line_report_xls`` for an example. +* Dynamic syntax: cf. ``report_xlsx_helper_demo`` for an example + +The ``AbstractReportXlsx`` class contains a number of attributes and methods to +facilitate the creation excel reports in Odoo. + +* Cell types + + string, number, boolean, datetime. + +* Cell formats + + The predefined cell formats result in a consistent + look and feel of the Odoo Excel reports. + +* Cell formulas + + Cell formulas can be easily added with the help of the ``_rowcol_to_cell()`` method. + +* Excel templates + + It is possible to define Excel templates which can be adapted + by 'inherited' modules. + Download the ``account_move_line_report_xls`` module + from http://apps.odoo.com as example. + +* Excel with multiple sheets + + Download the ``account_asset_management_xls`` module + from http://apps.odoo.com as example. diff --git a/report_xlsx_helper/report/__init__.py b/report_xlsx_helper/report/__init__.py new file mode 100644 index 000000000..3222e9d5c --- /dev/null +++ b/report_xlsx_helper/report/__init__.py @@ -0,0 +1,2 @@ +from . import report_xlsx_abstract +from . import test_partner_report_xlsx diff --git a/report_xlsx_helper/report/report_xlsx_abstract.py b/report_xlsx_helper/report/report_xlsx_abstract.py new file mode 100644 index 000000000..375fca823 --- /dev/null +++ b/report_xlsx_helper/report/report_xlsx_abstract.py @@ -0,0 +1,665 @@ +# Copyright 2009-2018 Noviat. +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +import re +from datetime import date, datetime +from types import CodeType + +from xlsxwriter.utility import xl_rowcol_to_cell + +from odoo import _, fields, models +from odoo.exceptions import UserError + + +class ReportXlsxAbstract(models.AbstractModel): + _inherit = "report.report_xlsx.abstract" + + def generate_xlsx_report(self, workbook, data, objects): + self._define_formats(workbook) + for ws_params in self._get_ws_params(workbook, data, objects): + ws_name = ws_params.get("ws_name") + ws_name = self._check_ws_name(ws_name) + ws = workbook.add_worksheet(ws_name) + generate_ws_method = getattr(self, ws_params["generate_ws_method"]) + generate_ws_method(workbook, ws, ws_params, data, objects) + + def _check_ws_name(self, name, sanitize=True): + pattern = re.compile(r"[/\\*\[\]:?]") # invalid characters: /\*[]:? + max_chars = 31 + if sanitize: + # we could drop these two lines since a similar + # sanitize is done in tools.misc PatchedXlsxWorkbook + name = pattern.sub("", name) + name = name[:max_chars] + else: + if len(name) > max_chars: + raise UserError( + _( + "Programming Error:\n\n" + "Excel Sheet name '%s' should not exceed %s characters." + ) + % (name, max_chars) + ) + special_chars = pattern.findall(name) + if special_chars: + raise UserError( + _( + "Programming Error:\n\n" + "Excel Sheet name '%s' contains unsupported special " + "characters: '%s'." + ) + % (name, special_chars) + ) + return name + + def _get_ws_params(self, workbook, data, objects): + """ + Return list of dictionaries with parameters for the + worksheets. + + Keywords: + - 'generate_ws_method': mandatory + - 'ws_name': name of the worksheet + - 'title': title of the worksheet + - 'wanted_list': list of column names + - 'col_specs': cf. XXX + + The 'generate_ws_method' must be present in your report + and contain the logic to generate the content of the worksheet. + """ + return [] + + def _define_xls_headers(self, workbook): + """ + Predefined worksheet headers/footers. + """ + hf_params = { + "font_size": 8, + "font_style": "I", # B: Bold, I: Italic, U: Underline + } + self.xls_headers = {"standard": ""} + report_date = fields.Datetime.context_timestamp( + self.env.user, datetime.now() + ).strftime("%Y-%m-%d %H:%M") + self.xls_footers = { + "standard": ( + "&L&%(font_size)s&%(font_style)s" + + report_date + + "&R&%(font_size)s&%(font_style)s&P / &N" + ) + % hf_params + } + + def _define_formats(self, workbook): + """ + This section contains a number of pre-defined formats. + It is recommended to use these in order to have a + consistent look & feel between your XLSX reports. + """ + self._define_xls_headers(workbook) + + border_grey = "#D3D3D3" + border = {"border": True, "border_color": border_grey} + theader = dict(border, bold=True) + bg_yellow = "#FFFFCC" + bg_blue = "#CCFFFF" + num_format = "#,##0.00" + num_format_conditional = "{0};[Red]-{0};{0}".format(num_format) + pct_format = "#,##0.00%" + pct_format_conditional = "{0};[Red]-{0};{0}".format(pct_format) + int_format = "#,##0" + int_format_conditional = "{0};[Red]-{0};{0}".format(int_format) + date_format = "YYYY-MM-DD" + theader_yellow = dict(theader, bg_color=bg_yellow) + theader_blue = dict(theader, bg_color=bg_blue) + + # format for worksheet title + self.format_ws_title = workbook.add_format({"bold": True, "font_size": 14}) + + # no border formats + self.format_left = workbook.add_format({"align": "left"}) + self.format_center = workbook.add_format({"align": "center"}) + self.format_right = workbook.add_format({"align": "right"}) + self.format_amount_left = workbook.add_format( + {"align": "left", "num_format": num_format} + ) + self.format_amount_center = workbook.add_format( + {"align": "center", "num_format": num_format} + ) + self.format_amount_right = workbook.add_format( + {"align": "right", "num_format": num_format} + ) + self.format_amount_conditional_left = workbook.add_format( + {"align": "left", "num_format": num_format_conditional} + ) + self.format_amount_conditional_center = workbook.add_format( + {"align": "center", "num_format": num_format_conditional} + ) + self.format_amount_conditional_right = workbook.add_format( + {"align": "right", "num_format": num_format_conditional} + ) + self.format_percent_left = workbook.add_format( + {"align": "left", "num_format": pct_format} + ) + self.format_percent_center = workbook.add_format( + {"align": "center", "num_format": pct_format} + ) + self.format_percent_right = workbook.add_format( + {"align": "right", "num_format": pct_format} + ) + self.format_percent_conditional_left = workbook.add_format( + {"align": "left", "num_format": pct_format_conditional} + ) + self.format_percent_conditional_center = workbook.add_format( + {"align": "center", "num_format": pct_format_conditional} + ) + self.format_percent_conditional_right = workbook.add_format( + {"align": "right", "num_format": pct_format_conditional} + ) + self.format_integer_left = workbook.add_format( + {"align": "left", "num_format": int_format} + ) + self.format_integer_center = workbook.add_format( + {"align": "center", "num_format": int_format} + ) + self.format_integer_right = workbook.add_format( + {"align": "right", "num_format": int_format} + ) + self.format_integer_conditional_left = workbook.add_format( + {"align": "right", "num_format": int_format_conditional} + ) + self.format_integer_conditional_center = workbook.add_format( + {"align": "center", "num_format": int_format_conditional} + ) + self.format_integer_conditional_right = workbook.add_format( + {"align": "right", "num_format": int_format_conditional} + ) + self.format_date_left = workbook.add_format( + {"align": "left", "num_format": date_format} + ) + self.format_date_center = workbook.add_format( + {"align": "center", "num_format": date_format} + ) + self.format_date_right = workbook.add_format( + {"align": "right", "num_format": date_format} + ) + + self.format_left_bold = workbook.add_format({"align": "left", "bold": True}) + self.format_center_bold = workbook.add_format({"align": "center", "bold": True}) + self.format_right_bold = workbook.add_format({"align": "right", "bold": True}) + self.format_amount_left_bold = workbook.add_format( + {"align": "left", "bold": True, "num_format": num_format} + ) + self.format_amount_center_bold = workbook.add_format( + {"align": "center", "bold": True, "num_format": num_format} + ) + self.format_amount_right_bold = workbook.add_format( + {"align": "right", "bold": True, "num_format": num_format} + ) + self.format_amount_conditional_left_bold = workbook.add_format( + {"align": "left", "bold": True, "num_format": num_format_conditional} + ) + self.format_amount_conditional_center_bold = workbook.add_format( + {"align": "center", "bold": True, "num_format": num_format_conditional} + ) + self.format_amount_conditional_right_bold = workbook.add_format( + {"align": "right", "bold": True, "num_format": num_format_conditional} + ) + self.format_percent_left_bold = workbook.add_format( + {"align": "left", "bold": True, "num_format": pct_format} + ) + self.format_percent_center_bold = workbook.add_format( + {"align": "center", "bold": True, "num_format": pct_format} + ) + self.format_percent_right_bold = workbook.add_format( + {"align": "right", "bold": True, "num_format": pct_format} + ) + self.format_percent_conditional_left_bold = workbook.add_format( + {"align": "left", "bold": True, "num_format": pct_format_conditional} + ) + self.format_percent_conditional_center_bold = workbook.add_format( + {"align": "center", "bold": True, "num_format": pct_format_conditional} + ) + self.format_percent_conditional_right_bold = workbook.add_format( + {"align": "right", "bold": True, "num_format": pct_format_conditional} + ) + self.format_integer_left_bold = workbook.add_format( + {"align": "left", "bold": True, "num_format": int_format} + ) + self.format_integer_center_bold = workbook.add_format( + {"align": "center", "bold": True, "num_format": int_format} + ) + self.format_integer_right_bold = workbook.add_format( + {"align": "right", "bold": True, "num_format": int_format} + ) + self.format_integer_conditional_left_bold = workbook.add_format( + {"align": "left", "bold": True, "num_format": int_format_conditional} + ) + self.format_integer_conditional_center_bold = workbook.add_format( + {"align": "center", "bold": True, "num_format": int_format_conditional} + ) + self.format_integer_conditional_right_bold = workbook.add_format( + {"align": "right", "bold": True, "num_format": int_format_conditional} + ) + self.format_date_left_bold = workbook.add_format( + {"align": "left", "bold": True, "num_format": date_format} + ) + self.format_date_center_bold = workbook.add_format( + {"align": "center", "bold": True, "num_format": date_format} + ) + self.format_date_right_bold = workbook.add_format( + {"align": "right", "bold": True, "num_format": date_format} + ) + + # formats for worksheet table column headers + self.format_theader_yellow_left = workbook.add_format(theader_yellow) + self.format_theader_yellow_center = workbook.add_format( + dict(theader_yellow, align="center") + ) + self.format_theader_yellow_right = workbook.add_format( + dict(theader_yellow, align="right") + ) + self.format_theader_yellow_amount_left = workbook.add_format( + dict(theader_yellow, num_format=num_format, align="left") + ) + self.format_theader_yellow_amount_center = workbook.add_format( + dict(theader_yellow, num_format=num_format, align="center") + ) + self.format_theader_yellow_amount_right = workbook.add_format( + dict(theader_yellow, num_format=num_format, align="right") + ) + + self.format_theader_yellow_amount_conditional_left = workbook.add_format( + dict(theader_yellow, num_format=num_format_conditional, align="left") + ) + self.format_theader_yellow_amount_conditional_center = workbook.add_format( + dict(theader_yellow, num_format=num_format_conditional, align="center") + ) + self.format_theader_yellow_amount_conditional_right = workbook.add_format( + dict(theader_yellow, num_format=num_format_conditional, align="right") + ) + self.format_theader_yellow_percent_left = workbook.add_format( + dict(theader_yellow, num_format=pct_format, align="left") + ) + self.format_theader_yellow_percent_center = workbook.add_format( + dict(theader_yellow, num_format=pct_format, align="center") + ) + self.format_theader_yellow_percent_right = workbook.add_format( + dict(theader_yellow, num_format=pct_format, align="right") + ) + self.format_theader_yellow_percent_conditional_left = workbook.add_format( + dict(theader_yellow, num_format=pct_format_conditional, align="left") + ) + self.format_theader_yellow_percent_conditional_center = workbook.add_format( + dict(theader_yellow, num_format=pct_format_conditional, align="center") + ) + self.format_theader_yellow_percent_conditional_right = workbook.add_format( + dict(theader_yellow, num_format=pct_format_conditional, align="right") + ) + self.format_theader_yellow_integer_left = workbook.add_format( + dict(theader_yellow, num_format=int_format, align="left") + ) + self.format_theader_yellow_integer_center = workbook.add_format( + dict(theader_yellow, num_format=int_format, align="center") + ) + self.format_theader_yellow_integer_right = workbook.add_format( + dict(theader_yellow, num_format=int_format, align="right") + ) + self.format_theader_yellow_integer_conditional_left = workbook.add_format( + dict(theader_yellow, num_format=int_format_conditional, align="left") + ) + self.format_theader_yellow_integer_conditional_center = workbook.add_format( + dict(theader_yellow, num_format=int_format_conditional, align="center") + ) + self.format_theader_yellow_integer_conditional_right = workbook.add_format( + dict(theader_yellow, num_format=int_format_conditional, align="right") + ) + + self.format_theader_blue_left = workbook.add_format(theader_blue) + self.format_theader_blue_center = workbook.add_format( + dict(theader_blue, align="center") + ) + self.format_theader_blue_right = workbook.add_format( + dict(theader_blue, align="right") + ) + self.format_theader_blue_amount_left = workbook.add_format( + dict(theader_blue, num_format=num_format, align="left") + ) + self.format_theader_blue_amount_center = workbook.add_format( + dict(theader_blue, num_format=num_format, align="center") + ) + self.format_theader_blue_amount_right = workbook.add_format( + dict(theader_blue, num_format=num_format, align="right") + ) + self.format_theader_blue_amount_conditional_left = workbook.add_format( + dict(theader_blue, num_format=num_format_conditional, align="left") + ) + self.format_theader_blue_amount_conditional_center = workbook.add_format( + dict(theader_blue, num_format=num_format_conditional, align="center") + ) + self.format_theader_blue_amount_conditional_right = workbook.add_format( + dict(theader_blue, num_format=num_format_conditional, align="right") + ) + self.format_theader_blue_percent_left = workbook.add_format( + dict(theader_blue, num_format=pct_format, align="left") + ) + self.format_theader_blue_percent_center = workbook.add_format( + dict(theader_blue, num_format=pct_format, align="center") + ) + self.format_theader_blue_percent_right = workbook.add_format( + dict(theader_blue, num_format=pct_format, align="right") + ) + self.format_theader_blue_percent_conditional_left = workbook.add_format( + dict(theader_blue, num_format=pct_format_conditional, align="left") + ) + self.format_theader_blue_percent_conditional_center = workbook.add_format( + dict(theader_blue, num_format=pct_format_conditional, align="center") + ) + self.format_theader_blue_percent_conditional_right = workbook.add_format( + dict(theader_blue, num_format=pct_format_conditional, align="right") + ) + self.format_theader_blue_integer_left = workbook.add_format( + dict(theader_blue, num_format=int_format, align="left") + ) + self.format_theader_blue_integer_center = workbook.add_format( + dict(theader_blue, num_format=int_format, align="center") + ) + self.format_theader_blue_integer_right = workbook.add_format( + dict(theader_blue, num_format=int_format, align="right") + ) + self.format_theader_blue_integer_conditional_left = workbook.add_format( + dict(theader_blue, num_format=int_format_conditional, align="left") + ) + self.format_theader_blue_integer_conditional_center = workbook.add_format( + dict(theader_blue, num_format=int_format_conditional, align="center") + ) + self.format_theader_blue_integer_conditional_right = workbook.add_format( + dict(theader_blue, num_format=int_format_conditional, align="right") + ) + + # formats for worksheet table cells + self.format_tcell_left = workbook.add_format(dict(border, align="left")) + self.format_tcell_center = workbook.add_format(dict(border, align="center")) + self.format_tcell_right = workbook.add_format(dict(border, align="right")) + self.format_tcell_amount_left = workbook.add_format( + dict(border, num_format=num_format, align="left") + ) + self.format_tcell_amount_center = workbook.add_format( + dict(border, num_format=num_format, align="center") + ) + self.format_tcell_amount_right = workbook.add_format( + dict(border, num_format=num_format, align="right") + ) + self.format_tcell_amount_conditional_left = workbook.add_format( + dict(border, num_format=num_format_conditional, align="left") + ) + self.format_tcell_amount_conditional_center = workbook.add_format( + dict(border, num_format=num_format_conditional, align="center") + ) + self.format_tcell_amount_conditional_right = workbook.add_format( + dict(border, num_format=num_format_conditional, align="right") + ) + self.format_tcell_percent_left = workbook.add_format( + dict(border, num_format=pct_format, align="left") + ) + self.format_tcell_percent_center = workbook.add_format( + dict(border, num_format=pct_format, align="center") + ) + self.format_tcell_percent_right = workbook.add_format( + dict(border, num_format=pct_format, align="right") + ) + self.format_tcell_percent_conditional_left = workbook.add_format( + dict(border, num_format=pct_format_conditional, align="left") + ) + self.format_tcell_percent_conditional_center = workbook.add_format( + dict(border, num_format=pct_format_conditional, align="center") + ) + self.format_tcell_percent_conditional_right = workbook.add_format( + dict(border, num_format=pct_format_conditional, align="right") + ) + self.format_tcell_integer_left = workbook.add_format( + dict(border, num_format=int_format, align="left") + ) + self.format_tcell_integer_center = workbook.add_format( + dict(border, num_format=int_format, align="center") + ) + self.format_tcell_integer_right = workbook.add_format( + dict(border, num_format=int_format, align="right") + ) + self.format_tcell_integer_conditional_left = workbook.add_format( + dict(border, num_format=int_format_conditional, align="left") + ) + self.format_tcell_integer_conditional_center = workbook.add_format( + dict(border, num_format=int_format_conditional, align="center") + ) + self.format_tcell_integer_conditional_right = workbook.add_format( + dict(border, num_format=int_format_conditional, align="right") + ) + self.format_tcell_date_left = workbook.add_format( + dict(border, num_format=date_format, align="left") + ) + self.format_tcell_date_center = workbook.add_format( + dict(border, num_format=date_format, align="center") + ) + self.format_tcell_date_right = workbook.add_format( + dict(border, num_format=date_format, align="right") + ) + + self.format_tcell_left_bold = workbook.add_format( + dict(border, align="left", bold=True) + ) + self.format_tcell_center_bold = workbook.add_format( + dict(border, align="center", bold=True) + ) + self.format_tcell_right_bold = workbook.add_format( + dict(border, align="right", bold=True) + ) + self.format_tcell_amount_left_bold = workbook.add_format( + dict(border, num_format=num_format, align="left", bold=True) + ) + self.format_tcell_amount_center_bold = workbook.add_format( + dict(border, num_format=num_format, align="center", bold=True) + ) + self.format_tcell_amount_right_bold = workbook.add_format( + dict(border, num_format=num_format, align="right", bold=True) + ) + self.format_tcell_amount_conditional_left_bold = workbook.add_format( + dict(border, num_format=num_format_conditional, align="left", bold=True) + ) + self.format_tcell_amount_conditional_center_bold = workbook.add_format( + dict(border, num_format=num_format_conditional, align="center", bold=True) + ) + self.format_tcell_amount_conditional_right_bold = workbook.add_format( + dict(border, num_format=num_format_conditional, align="right", bold=True) + ) + self.format_tcell_percent_left_bold = workbook.add_format( + dict(border, num_format=pct_format, align="left", bold=True) + ) + self.format_tcell_percent_center_bold = workbook.add_format( + dict(border, num_format=pct_format, align="center", bold=True) + ) + self.format_tcell_percent_right_bold = workbook.add_format( + dict(border, num_format=pct_format, align="right", bold=True) + ) + self.format_tcell_percent_conditional_left_bold = workbook.add_format( + dict(border, num_format=pct_format_conditional, align="left", bold=True) + ) + self.format_tcell_percent_conditional_center_bold = workbook.add_format( + dict(border, num_format=pct_format_conditional, align="center", bold=True) + ) + self.format_tcell_percent_conditional_right_bold = workbook.add_format( + dict(border, num_format=pct_format_conditional, align="right", bold=True) + ) + self.format_tcell_integer_left_bold = workbook.add_format( + dict(border, num_format=int_format, align="left", bold=True) + ) + self.format_tcell_integer_center_bold = workbook.add_format( + dict(border, num_format=int_format, align="center", bold=True) + ) + self.format_tcell_integer_right_bold = workbook.add_format( + dict(border, num_format=int_format, align="right", bold=True) + ) + self.format_tcell_integer_conditional_left_bold = workbook.add_format( + dict(border, num_format=int_format_conditional, align="left", bold=True) + ) + self.format_tcell_integer_conditional_center_bold = workbook.add_format( + dict(border, num_format=int_format_conditional, align="center", bold=True) + ) + self.format_tcell_integer_conditional_right_bold = workbook.add_format( + dict(border, num_format=int_format_conditional, align="right", bold=True) + ) + self.format_tcell_date_left_bold = workbook.add_format( + dict(border, num_format=date_format, align="left", bold=True) + ) + self.format_tcell_date_center_bold = workbook.add_format( + dict(border, num_format=date_format, align="center", bold=True) + ) + self.format_tcell_date_right_bold = workbook.add_format( + dict(border, num_format=date_format, align="right", bold=True) + ) + + def _set_column_width(self, ws, ws_params): + """ + Set width for all columns included in the 'wanted_list'. + """ + col_specs = ws_params.get("col_specs") + wl = ws_params.get("wanted_list") or [] + for pos, col in enumerate(wl): + if col not in col_specs: + raise UserError( + _( + "Programming Error:\n\n" + "The '%s' column is not defined in the worksheet " + "column specifications." + ) + % col + ) + ws.set_column(pos, pos, col_specs[col]["width"]) + + def _write_ws_title(self, ws, row_pos, ws_params, merge_range=False): + """ + Helper function to ensure consistent title formats + troughout all worksheets. + Requires 'title' keyword in ws_params. + """ + title = ws_params.get("title") + if not title: + raise UserError( + _( + "Programming Error:\n\n" + "The 'title' parameter is mandatory " + "when calling the '_write_ws_title' method." + ) + ) + if merge_range: + wl = ws_params.get("wanted_list") + if wl and len(wl) > 1: + ws.merge_range( + row_pos, 0, row_pos, len(wl) - 1, title, self.format_ws_title + ) + else: + ws.write_string(row_pos, 0, title, self.format_ws_title) + return row_pos + 2 + + def _write_line( + self, + ws, + row_pos, + ws_params, + col_specs_section=None, + render_space=None, + default_format=None, + ): + """ + Write a line with all columns included in the 'wanted_list'. + Use the entry defined by the col_specs_section. + An empty cell will be written if no col_specs_section entry + for a column. + """ + col_specs = ws_params.get("col_specs") + wl = ws_params.get("wanted_list") or [] + pos = 0 + for col in wl: + if col not in col_specs: + raise UserError( + _( + "Programming Error:\n\n" + "The '%s' column is not defined the worksheet " + "column specifications." + ) + % col + ) + colspan = col_specs[col].get("colspan") or 1 + cell_spec = col_specs[col].get(col_specs_section) or {} + if not cell_spec: + cell_value = None + cell_type = "blank" + cell_format = default_format + else: + cell_value = cell_spec.get("value") + if isinstance(cell_value, CodeType): + cell_value = self._eval(cell_value, render_space) + cell_type = cell_spec.get("type") + cell_format = cell_spec.get("format") or default_format + if not cell_type: + # test bool first since isinstance(val, int) returns + # True when type(val) is bool + if isinstance(cell_value, bool): + cell_type = "boolean" + elif isinstance(cell_value, str): + cell_type = "string" + elif isinstance(cell_value, (int, float)): + cell_type = "number" + elif isinstance(cell_value, datetime): + cell_type = "datetime" + elif isinstance(cell_value, date): + cell_value = datetime.combine(cell_value, datetime.min.time()) + cell_type = "datetime" + else: + if not cell_value: + cell_type = "blank" + else: + msg = _( + "%s, _write_line : programming error " + "detected while processing " + "col_specs_section %s, column %s" + ) % (__name__, col_specs_section, col) + if cell_value: + msg += _(", cellvalue %s") % cell_value + raise UserError(msg) + colspan = cell_spec.get("colspan") or colspan + args_pos = [row_pos, pos] + args_data = [cell_value] + if cell_format: + if isinstance(cell_format, CodeType): + cell_format = self._eval(cell_format, render_space) + args_data.append(cell_format) + if colspan > 1: + args_pos += [row_pos, pos + colspan - 1] + args = args_pos + args_data + ws.merge_range(*args) + else: + ws_method = getattr(ws, "write_%s" % cell_type) + args = args_pos + args_data + ws_method(*args) + pos += colspan + + return row_pos + 1 + + @staticmethod + def _render(code): + return compile(code, "", "eval") + + @staticmethod + def _eval(val, render_space): + if not render_space: + render_space = {} + if "datetime" not in render_space: + render_space["datetime"] = datetime + # the use of eval is not a security thread as long as the + # col_specs template is defined in a python module + return eval(val, render_space) # pylint: disable=W0123,W8112 + + @staticmethod + def _rowcol_to_cell(row, col, row_abs=False, col_abs=False): + return xl_rowcol_to_cell(row, col, row_abs=row_abs, col_abs=col_abs) diff --git a/report_xlsx_helper/report/test_partner_report_xlsx.py b/report_xlsx_helper/report/test_partner_report_xlsx.py new file mode 100644 index 000000000..f175608d5 --- /dev/null +++ b/report_xlsx_helper/report/test_partner_report_xlsx.py @@ -0,0 +1,74 @@ +# Copyright 2009-2019 Noviat. +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import models + + +# TODO: +# make PR to move this class as well as the report_xlsx test class +# to the tests folder (requires dynamic update Odoo registry when +# running unit tests. +class TestPartnerXlsx(models.AbstractModel): + _name = "report.report_xlsx_helper.test_partner_xlsx" + _inherit = "report.report_xlsx.abstract" + _description = "Test Partner XLSX Report" + + def _get_ws_params(self, wb, data, partners): + + partner_template = { + "name": { + "header": {"value": "Name"}, + "data": {"value": self._render("partner.name")}, + "width": 20, + }, + "number_of_contacts": { + "header": {"value": "# Contacts"}, + "data": {"value": self._render("len(partner.child_ids)")}, + "width": 10, + }, + "date": { + "header": {"value": "Date"}, + "data": {"value": self._render("partner.date")}, + "width": 13, + }, + } + + ws_params = { + "ws_name": "Partners", + "generate_ws_method": "_partner_report", + "title": "Partners", + "wanted_list": [k for k in partner_template], + "col_specs": partner_template, + } + + return [ws_params] + + def _partner_report(self, workbook, ws, ws_params, data, partners): + + ws.set_portrait() + ws.fit_to_pages(1, 0) + ws.set_header(self.xls_headers["standard"]) + ws.set_footer(self.xls_footers["standard"]) + + self._set_column_width(ws, ws_params) + + row_pos = 0 + row_pos = self._write_ws_title(ws, row_pos, ws_params) + row_pos = self._write_line( + ws, + row_pos, + ws_params, + col_specs_section="header", + default_format=self.format_theader_yellow_left, + ) + ws.freeze_panes(row_pos, 0) + + for partner in partners: + row_pos = self._write_line( + ws, + row_pos, + ws_params, + col_specs_section="data", + render_space={"partner": partner}, + default_format=self.format_tcell_left, + ) diff --git a/report_xlsx_helper/static/description/icon.png b/report_xlsx_helper/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/report_xlsx_helper/static/description/icon.png differ diff --git a/report_xlsx_helper/static/description/index.html b/report_xlsx_helper/static/description/index.html new file mode 100644 index 000000000..adf87d3a8 --- /dev/null +++ b/report_xlsx_helper/static/description/index.html @@ -0,0 +1,458 @@ + + + + + + +Report xlsx helpers + + + +
+

Report xlsx helpers

+ + +

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runbot

+

This module provides a set of tools to facilitate the creation of excel reports with format xlsx.

+

Table of contents

+ +
+

Installation

+

This module requires report_xlsx version 13.0.1.0.0 or higher.

+
+
+

Usage

+

In order to create an Excel report you can define a report of type ‘xlsx’ in a static or dynamic way:

+
    +
  • Static syntax: cf. account_move_line_report_xls for an example.
    • +
  • Dynamic syntax: cf. report_xlsx_helper_demo for an example
    • +
+

The AbstractReportXlsx class contains a number of attributes and methods to +facilitate the creation excel reports in Odoo.

+
    +

  • Cell types

    +

    string, number, boolean, datetime.

    +
    • +

  • Cell formats

    +

    The predefined cell formats result in a consistent +look and feel of the Odoo Excel reports.

    +
    • +

  • Cell formulas

    +

    Cell formulas can be easily added with the help of the _rowcol_to_cell() method.

    +
    • +

  • Excel templates

    +

    It is possible to define Excel templates which can be adapted +by ‘inherited’ modules. +Download the account_move_line_report_xls module +from http://apps.odoo.com as example.

    +
    • +

  • Excel with multiple sheets

    +

    Download the account_asset_management_xls module +from http://apps.odoo.com as example.

    +
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Noviat
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/reporting-engine project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/report_xlsx_helper/tests/__init__.py b/report_xlsx_helper/tests/__init__.py new file mode 100644 index 000000000..e33d6b905 --- /dev/null +++ b/report_xlsx_helper/tests/__init__.py @@ -0,0 +1 @@ +from . import test_report_xlsx_helper diff --git a/report_xlsx_helper/tests/test_report_xlsx_helper.py b/report_xlsx_helper/tests/test_report_xlsx_helper.py new file mode 100644 index 000000000..6ffa41259 --- /dev/null +++ b/report_xlsx_helper/tests/test_report_xlsx_helper.py @@ -0,0 +1,27 @@ +# Copyright 2009-2019 Noviat. +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from datetime import date + +from odoo.tests.common import TransactionCase + + +class TestReportXlsxHelper(TransactionCase): + def setUp(self): + super(TestReportXlsxHelper, self).setUp() + today = date.today() + p1 = self.env.ref("base.res_partner_1") + p2 = self.env.ref("base.res_partner_2") + p1.date = today + p2.date = today + self.partners = p1 + p2 + ctx = { + "report_name": "report_xlsx_helper.test_partner_xlsx", + "active_model": "res.partner", + "active_ids": self.partners.ids, + } + self.report = self.env["ir.actions.report"].with_context(ctx) + + def test_report_xlsx_helper(self): + report_xls = self.report.render_xlsx(None, None) + self.assertEqual(report_xls[1], "xlsx")