Browse Source

Merge pull request #243 from Noviat/11.0-mig-report_xlsx_helper

[11.0][MIG]report_xlsx_helper
pull/259/head
Yannick Vaucher 6 years ago
committed by GitHub
parent
commit
a856239f90
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 88
      report_xlsx_helper/README.rst
  2. 3
      report_xlsx_helper/__init__.py
  3. 16
      report_xlsx_helper/__manifest__.py
  4. 1
      report_xlsx_helper/controllers/__init__.py
  5. 54
      report_xlsx_helper/controllers/main.py
  6. 67
      report_xlsx_helper/i18n/report_xlsx_helper.pot
  7. 1
      report_xlsx_helper/models/__init__.py
  8. 21
      report_xlsx_helper/models/ir_actions_report.py
  9. 1
      report_xlsx_helper/readme/CONTRIBUTORS.rst
  10. 1
      report_xlsx_helper/readme/DESCRIPTION.rst
  11. 1
      report_xlsx_helper/readme/INSTALL.rst
  12. 32
      report_xlsx_helper/readme/USAGE.rst
  13. 2
      report_xlsx_helper/report/__init__.py
  14. 551
      report_xlsx_helper/report/report_xlsx_abstract.py
  15. 98
      report_xlsx_helper/report/test_partner_report_xlsx.py
  16. BIN
      report_xlsx_helper/static/description/icon.png
  17. 1
      report_xlsx_helper/tests/__init__.py
  18. 23
      report_xlsx_helper/tests/test_report_xlsx_helper.py
  19. 58
      report_xlsx_helper_demo/README.rst
  20. 2
      report_xlsx_helper_demo/__init__.py
  21. 18
      report_xlsx_helper_demo/__manifest__.py
  22. 1
      report_xlsx_helper_demo/models/__init__.py
  23. 25
      report_xlsx_helper_demo/models/res_partner.py
  24. 1
      report_xlsx_helper_demo/report/__init__.py
  25. 99
      report_xlsx_helper_demo/report/partner_export_xlsx.py
  26. BIN
      report_xlsx_helper_demo/static/description/icon.png
  27. 19
      report_xlsx_helper_demo/views/res_partner.xml

88
report_xlsx_helper/README.rst

@ -0,0 +1,88 @@
.. 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
===========================
This module provides a set of tools to facilitate the creation of excel reports with format xlsx.
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.
Installation
============
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/11.0
Bug Tracker
===========
Bugs are tracked on `GitHub Issues
<https://github.com/OCA/reporting-engine/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 <luc.demeyer@noviat.com>
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.

3
report_xlsx_helper/__init__.py

@ -0,0 +1,3 @@
from . import controllers
from . import models
from . import report

16
report_xlsx_helper/__manifest__.py

@ -0,0 +1,16 @@
# Copyright 2009-2018 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': '11.0.1.0.0',
'license': 'AGPL-3',
'depends': [
'report_xlsx',
],
'installable': True,
}

1
report_xlsx_helper/controllers/__init__.py

@ -0,0 +1 @@
from . import main

54
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/<converter>/<reportname>',
'/report/<converter>/<reportname>/<docids>',
], 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)

67
report_xlsx_helper/i18n/report_xlsx_helper.pot

@ -0,0 +1,67 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * report_xlsx_helper
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 10.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/report/abstract_report_xlsx.py:520
#, 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/abstract_report_xlsx.py:526
#, python-format
msgid ", cellvalue %s"
msgstr ""
#. module: report_xlsx_helper
#: code:addons/report_xlsx_helper/report/abstract_report_xlsx.py:52
#, 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/abstract_report_xlsx.py:46
#, 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/abstract_report_xlsx.py:448
#, 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/abstract_report_xlsx.py:489
#, 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/abstract_report_xlsx.py:462
#, python-format
msgid "Programming Error:\n"
"\n"
"The 'title' parameter is mandatory when calling the '_write_ws_title' method."
msgstr ""

1
report_xlsx_helper/models/__init__.py

@ -0,0 +1 @@
from . import ir_actions_report

21
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)

1
report_xlsx_helper/readme/CONTRIBUTORS.rst

@ -0,0 +1 @@
* Luc De Meyer <luc.demeyer@noviat.com>

1
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.

1
report_xlsx_helper/readme/INSTALL.rst

@ -0,0 +1 @@
This module requires report_xlsx version 11.0.1.0.3 or higher.

32
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.

2
report_xlsx_helper/report/__init__.py

@ -0,0 +1,2 @@
from . import report_xlsx_abstract
from . import test_partner_report_xlsx

551
report_xlsx_helper/report/report_xlsx_abstract.py

@ -0,0 +1,551 @@
# Copyright 2009-2018 Noviat.
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from datetime import datetime
import re
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'
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")
raise UserError(msg)
colspan = cell_spec.get('colspan') or colspan
args_pos = [row_pos, pos]
args_data = [cell_value]
if cell_format:
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, '<string>', '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)

98
report_xlsx_helper/report/test_partner_report_xlsx.py

@ -0,0 +1,98 @@
# -*- coding: utf-8 -*-
# Copyright 2009-2018 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'
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,
},
}
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)
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)

BIN
report_xlsx_helper/static/description/icon.png

After

Width: 128  |  Height: 128  |  Size: 9.2 KiB

1
report_xlsx_helper/tests/__init__.py

@ -0,0 +1 @@
from . import test_report_xlsx_helper

23
report_xlsx_helper/tests/test_report_xlsx_helper.py

@ -0,0 +1,23 @@
# Copyright 2009-2018 Noviat.
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from odoo.tests.common import TransactionCase
class TestReportXlsxHelper(TransactionCase):
def setUp(self):
super(TestReportXlsxHelper, self).setUp()
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_xlsx(None, None)
self.assertEqual(report_xls[1], 'xlsx')

58
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
<https://github.com/OCA/reporting-engine/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 <luc.demeyer@noviat.com>
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.

2
report_xlsx_helper_demo/__init__.py

@ -0,0 +1,2 @@
from . import models
from . import report

18
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,
}

1
report_xlsx_helper_demo/models/__init__.py

@ -0,0 +1 @@
from . import res_partner

25
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

1
report_xlsx_helper_demo/report/__init__.py

@ -0,0 +1 @@
from . import partner_export_xlsx

99
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)

BIN
report_xlsx_helper_demo/static/description/icon.png

After

Width: 128  |  Height: 128  |  Size: 9.2 KiB

19
report_xlsx_helper_demo/views/res_partner.xml

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<record id="view_partner_form" model="ir.ui.view">
<field name="name">res.partner.test_xlsx</field>
<field name="model">res.partner</field>
<field name="inherit_id" ref="base.view_partner_form"/>
<field name="arch" type="xml">
<div name="button_box" position="inside">
<button type="object" class="oe_stat_button" icon="fa-file-excel-o" name="export_xls">
<div class="o_form_field o_stat_info">
<span class="o_stat_text">Export XLS</span>
</div>
</button>
</div>
</field>
</record>
</odoo>
Loading…
Cancel
Save