diff --git a/report_xlsx_helper/README.rst b/report_xlsx_helper/README.rst index 4be0dc36..142bdfdf 100644 --- a/report_xlsx_helper/README.rst +++ b/report_xlsx_helper/README.rst @@ -7,15 +7,14 @@ Excel report engine helpers =========================== This module provides a set of tools to facilitate the creation of excel reports with format xlsx. -This module offers a similar functional coverage as the 8.0 version of the ``report_xls`` module. Usage ===== -In order to create an Excel report you can: +In order to create an Excel report you can define a report of type 'xlsx' in a static or dynamic way: -- define a report of type 'xlsx' -- pass ``{'xlsx_export': 1}`` via the context to the report create method +* 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. @@ -48,14 +47,14 @@ facilitate the creation excel reports in Odoo. Installation ============ -There is no specific installation procedure for this module. +This module requires report_xlsx version 11.0.1.0.3 or higher. Configuration and Usage ======================= .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/143/10.0 + :target: https://runbot.odoo-community.org/runbot/143/11.0 Bug Tracker =========== diff --git a/report_xlsx_helper/__init__.py b/report_xlsx_helper/__init__.py index 8323e741..9b6fa04e 100644 --- a/report_xlsx_helper/__init__.py +++ b/report_xlsx_helper/__init__.py @@ -1,2 +1,3 @@ -# -*- coding: utf-8 -*- +from . import controllers +from . import models from . import report diff --git a/report_xlsx_helper/__manifest__.py b/report_xlsx_helper/__manifest__.py index 8cf9b6b7..afd22481 100644 --- a/report_xlsx_helper/__manifest__.py +++ b/report_xlsx_helper/__manifest__.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2009-2018 Noviat. # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). @@ -8,9 +7,8 @@ 'Odoo Community Association (OCA)', 'website': 'https://github.com/OCA/reporting-engine', 'category': 'Reporting', - 'version': '10.0.1.0.0', + 'version': '11.0.1.0.0', 'license': 'AGPL-3', - 'external_dependencies': {'python': ['xlsxwriter']}, 'depends': [ 'report_xlsx', ], diff --git a/report_xlsx_helper/controllers/__init__.py b/report_xlsx_helper/controllers/__init__.py new file mode 100644 index 00000000..12a7e529 --- /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 00000000..abaf974d --- /dev/null +++ b/report_xlsx_helper/controllers/main.py @@ -0,0 +1,54 @@ +# Copyright 2009-2018 Noviat. +# License AGPL-3.0 or later (https://www.gnuorg/licenses/agpl.html). + +import json + +from odoo.addons.report_xlsx.controllers.main import ReportController +from odoo.http import content_disposition, route, request + + +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/models/__init__.py b/report_xlsx_helper/models/__init__.py new file mode 100644 index 00000000..a248cf21 --- /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 00000000..81db27d0 --- /dev/null +++ b/report_xlsx_helper/models/ir_actions_report.py @@ -0,0 +1,21 @@ +# 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 00000000..044d1a00 --- /dev/null +++ b/report_xlsx_helper/readme/CONTRIBUTORS.rst @@ -0,0 +1 @@ +* Luc De Meyer diff --git a/report_xlsx_helper/readme/DESCRIPTION.rst b/report_xlsx_helper/readme/DESCRIPTION.rst new file mode 100644 index 00000000..f0fc0ee5 --- /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. \ No newline at end of file diff --git a/report_xlsx_helper/readme/INSTALL.rst b/report_xlsx_helper/readme/INSTALL.rst new file mode 100644 index 00000000..4bcd5532 --- /dev/null +++ b/report_xlsx_helper/readme/INSTALL.rst @@ -0,0 +1 @@ +This module requires report_xlsx version 11.0.1.0.3 or higher. diff --git a/report_xlsx_helper/readme/USAGE.rst b/report_xlsx_helper/readme/USAGE.rst new file mode 100644 index 00000000..6efc211b --- /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 index efd56120..3222e9d5 100644 --- a/report_xlsx_helper/report/__init__.py +++ b/report_xlsx_helper/report/__init__.py @@ -1,2 +1,2 @@ -# -*- coding: utf-8 -*- -from . import abstract_report_xlsx +from . import report_xlsx_abstract +from . import test_partner_report_xlsx diff --git a/report_xlsx_helper/report/abstract_report_xlsx.py b/report_xlsx_helper/report/report_xlsx_abstract.py similarity index 97% rename from report_xlsx_helper/report/abstract_report_xlsx.py rename to report_xlsx_helper/report/report_xlsx_abstract.py index 62eaaac0..b93cf2a4 100644 --- a/report_xlsx_helper/report/abstract_report_xlsx.py +++ b/report_xlsx_helper/report/report_xlsx_abstract.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2009-2018 Noviat. # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). @@ -7,21 +6,12 @@ import re from types import CodeType from xlsxwriter.utility import xl_rowcol_to_cell -from odoo import api, fields, _ -from odoo.addons.report_xlsx.report.report_xlsx import ReportXlsx +from odoo import fields, models, _ from odoo.exceptions import UserError -class AbstractReportXlsx(ReportXlsx): - - # pylint: disable=old-api7-method-defined - def create(self, cr, uid, ids, data, context=None): - if context.get('xlsx_export'): - self.env = api.Environment(cr, uid, context) - return self.create_xlsx_report(ids, data, None) - else: - return super(AbstractReportXlsx, self).create( - cr, uid, ids, data, context=context) +class ReportXlsxAbstract(models.AbstractModel): + _inherit = 'report.report_xlsx.abstract' def generate_xlsx_report(self, workbook, data, objects): self._define_formats(workbook) @@ -507,9 +497,9 @@ class AbstractReportXlsx(ReportXlsx): # True when type(val) is bool if isinstance(cell_value, bool): cell_type = 'boolean' - elif isinstance(cell_value, basestring): + elif isinstance(cell_value, str): cell_type = 'string' - elif isinstance(cell_value, (int, long, float)): + elif isinstance(cell_value, (int, float)): cell_type = 'number' elif isinstance(cell_value, datetime): cell_type = 'datetime' diff --git a/report_xlsx_helper/tests/test_partner_report_xlsx.py b/report_xlsx_helper/report/test_partner_report_xlsx.py similarity index 87% rename from report_xlsx_helper/tests/test_partner_report_xlsx.py rename to report_xlsx_helper/report/test_partner_report_xlsx.py index 4623e4d9..53196771 100644 --- a/report_xlsx_helper/tests/test_partner_report_xlsx.py +++ b/report_xlsx_helper/report/test_partner_report_xlsx.py @@ -2,12 +2,12 @@ # Copyright 2009-2018 Noviat. # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -from odoo.addons.report_xlsx_helper.report.abstract_report_xlsx \ - import AbstractReportXlsx -from odoo.report import report_sxw +from odoo import models -class TestPartnerReportXlsx(AbstractReportXlsx): +class TestPartnerXlsx(models.AbstractModel): + _name = 'report.report_xlsx_helper.test_partner_xlsx' + _inherit = 'report.report_xlsx.abstract' def _get_ws_params(self, wb, data, partners): @@ -47,7 +47,7 @@ class TestPartnerReportXlsx(AbstractReportXlsx): 'type': 'formula', 'value': self._render("customer_formula"), }, - 'width': 10, + 'width': 14, }, } @@ -84,7 +84,7 @@ class TestPartnerReportXlsx(AbstractReportXlsx): wl.index('is_customer') is_customer_cell = self._rowcol_to_cell( row_pos, is_customer_pos) - customer_formula = 'IF(%s=TRUE;"Y"; "N")' % is_customer_cell + customer_formula = 'IF({},"Y", "N")'.format(is_customer_cell) row_pos = self._write_line( ws, row_pos, ws_params, col_specs_section='data', render_space={ @@ -92,9 +92,3 @@ class TestPartnerReportXlsx(AbstractReportXlsx): 'customer_formula': customer_formula, }, default_format=self.format_tcell_left) - - -TestPartnerReportXlsx( - 'report.test.partner.xlsx', - 'res.partner', - parser=report_sxw.rml_parse) diff --git a/report_xlsx_helper/tests/__init__.py b/report_xlsx_helper/tests/__init__.py index 798b9f69..e33d6b90 100644 --- a/report_xlsx_helper/tests/__init__.py +++ b/report_xlsx_helper/tests/__init__.py @@ -1,3 +1 @@ -# -*- coding: utf-8 -*- -from . import test_partner_report_xlsx 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 index e5b140a7..059c1243 100644 --- a/report_xlsx_helper/tests/test_report_xlsx_helper.py +++ b/report_xlsx_helper/tests/test_report_xlsx_helper.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2009-2018 Noviat. # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). @@ -9,14 +8,16 @@ class TestReportXlsxHelper(TransactionCase): def setUp(self): super(TestReportXlsxHelper, self).setUp() - ctx = {'xlsx_export': True} - self.report = self.env['ir.actions.report.xml'].with_context(ctx) - self.report_name = 'test.partner.xlsx' p1 = self.env.ref('base.res_partner_1') p2 = self.env.ref('base.res_partner_2') 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_report( - self.partners.ids, self.report_name, {}) + report_xls = self.report.render_xlsx(None, None) self.assertEqual(report_xls[1], 'xlsx') diff --git a/report_xlsx_helper_demo/README.rst b/report_xlsx_helper_demo/README.rst new file mode 100644 index 00000000..5730d9db --- /dev/null +++ b/report_xlsx_helper_demo/README.rst @@ -0,0 +1,58 @@ +.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png + :target: https://www.gnu.org/licenses/agpl + :alt: License: AGPL-3 + +================================== +Excel report engine helpers - demo +================================== + +This module demonstrates the capabilities or the report_xlsx_helper module via +a basic example. + +Usage +===== + +Open a partner record and click on the 'Export XLS' button. + +Installation +============ + +There is no specific installation procedure for this module. + +Configuration and Usage +======================= + +.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas + :alt: Try me on Runbot + :target: https://runbot.odoo-community.org/runbot/143/11.0 + +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. + +Credits +======= + +Contributors +------------ + +* Luc De Meyer + +Maintainer +---------- + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +This module is maintained by the OCA. + +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. + +To contribute to this module, please visit http://odoo-community.org. diff --git a/report_xlsx_helper_demo/__init__.py b/report_xlsx_helper_demo/__init__.py new file mode 100644 index 00000000..bf588bc8 --- /dev/null +++ b/report_xlsx_helper_demo/__init__.py @@ -0,0 +1,2 @@ +from . import models +from . import report diff --git a/report_xlsx_helper_demo/__manifest__.py b/report_xlsx_helper_demo/__manifest__.py new file mode 100644 index 00000000..c7c05651 --- /dev/null +++ b/report_xlsx_helper_demo/__manifest__.py @@ -0,0 +1,18 @@ +# Copyright 2009-2018 Noviat. +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +{ + 'name': 'Report xlsx helpers - demo', + 'author': 'Noviat,' + 'Odoo Community Association (OCA)', + 'category': 'Reporting', + 'version': '11.0.1.0.0', + 'license': 'AGPL-3', + 'depends': [ + 'report_xlsx_helper', + ], + 'data': [ + 'views/res_partner.xml', + ], + 'installable': True, +} diff --git a/report_xlsx_helper_demo/models/__init__.py b/report_xlsx_helper_demo/models/__init__.py new file mode 100644 index 00000000..91fed54d --- /dev/null +++ b/report_xlsx_helper_demo/models/__init__.py @@ -0,0 +1 @@ +from . import res_partner diff --git a/report_xlsx_helper_demo/models/res_partner.py b/report_xlsx_helper_demo/models/res_partner.py new file mode 100644 index 00000000..14fff263 --- /dev/null +++ b/report_xlsx_helper_demo/models/res_partner.py @@ -0,0 +1,25 @@ +# Copyright 2009-2018 Noviat +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import api, models + + +class ResPartner(models.Model): + _inherit = 'res.partner' + + @api.multi + def export_xls(self): + module = __name__.split('addons.')[1].split('.')[0] + report_name = '{}.partner_export_xlsx'.format(module) + report = { + 'type': 'ir.actions.report', + 'report_type': 'xlsx', + 'report_name': report_name, + # model name will be used if no report_file passed via context + 'context': dict(self.env.context, report_file='partner'), + # report_xlsx doesn't pass the context if the data dict is empty + # cf. report_xlsx\static\src\js\report\qwebactionmanager.js + # TODO: create PR on report_xlsx to fix this + 'data': {'dynamic_report': True}, + } + return report diff --git a/report_xlsx_helper_demo/report/__init__.py b/report_xlsx_helper_demo/report/__init__.py new file mode 100644 index 00000000..af555af1 --- /dev/null +++ b/report_xlsx_helper_demo/report/__init__.py @@ -0,0 +1 @@ +from . import partner_export_xlsx diff --git a/report_xlsx_helper_demo/report/partner_export_xlsx.py b/report_xlsx_helper_demo/report/partner_export_xlsx.py new file mode 100644 index 00000000..3ea0c813 --- /dev/null +++ b/report_xlsx_helper_demo/report/partner_export_xlsx.py @@ -0,0 +1,99 @@ +# -*- coding: utf-8 -*- +# Copyright 2009-2018 Noviat. +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import models + + +class PartnerExportXlsx(models.AbstractModel): + _name = 'report.report_xlsx_helper_demo.partner_export_xlsx' + _inherit = 'report.report_xlsx.abstract' + + 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, + }, + 'is_customer': { + 'header': { + 'value': 'Customer', + }, + 'data': { + 'value': self._render("partner.customer"), + }, + 'width': 10, + }, + 'is_customer_formula': { + 'header': { + 'value': 'Customer Y/N ?', + }, + 'data': { + 'type': 'formula', + 'value': self._render("customer_formula"), + }, + 'width': 14, + }, + } + + wanted_list = [ + 'name', 'number_of_contacts', 'is_customer', + 'is_customer_formula'] + ws_params = { + 'ws_name': 'Partners', + 'generate_ws_method': '_partner_report', + 'title': 'Partners', + 'wanted_list': wanted_list, + '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 + if len(partners) == 1: + ws_params['title'] = partners.name + 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) + + wl = ws_params['wanted_list'] + + for partner in partners: + is_customer_pos = 'is_customer' in wl and \ + wl.index('is_customer') + is_customer_cell = self._rowcol_to_cell( + row_pos, is_customer_pos) + customer_formula = 'IF({},"Y", "N")'.format(is_customer_cell) + row_pos = self._write_line( + ws, row_pos, ws_params, col_specs_section='data', + render_space={ + 'partner': partner, + 'customer_formula': customer_formula, + }, + default_format=self.format_tcell_left) diff --git a/report_xlsx_helper_demo/static/description/icon.png b/report_xlsx_helper_demo/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/report_xlsx_helper_demo/static/description/icon.png differ diff --git a/report_xlsx_helper_demo/views/res_partner.xml b/report_xlsx_helper_demo/views/res_partner.xml new file mode 100644 index 00000000..63f46199 --- /dev/null +++ b/report_xlsx_helper_demo/views/res_partner.xml @@ -0,0 +1,19 @@ + + + + + res.partner.test_xlsx + res.partner + + +
+ +
+
+
+ +