OCA / reporting-engine / 171

pending completion

Build # 171

Build Type

Pull #64

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/OCA/reporting-engine/commit/<a class=hub.com/OCA/reporting-engine/commit/e6b4a18f67e1dc6f8db20313dc3f38bd10a985f3">e6b4a18f6<a href="https://github.com/OCA/reporting-engine/commit/e6b4a18f67e1dc6f8db20313dc3f38bd10a985f3">&quot;&gt;[FIX][report_xls] Protect import.

Even after merging </a><a class="double-link" href="https://github.com/OCA/reporting-engine/commit/<a class="double-link" href="https://github.com/OCA/reporting-engine/commit/2bf93a1d49f7c79062ab7c237ceb794cdbdec983">2bf93a1d4</a>">2bf93a1d4</a><a href="https://github.com/OCA/reporting-engine/commit/e6b4a18f67e1dc6f8db20313dc3f38bd10a985f3">, import still breaks when trying to use module&#39;s stuff at class definition time when module is not imported.

I move xsl types to a failure-safe scope.

Pull Request Pull Request #64: [FIX][report_xls] Protect import.

Run Details

4 of 4 new or added lines in 1 file covered. (100.0%)

182 of 601 relevant lines covered (30.28%)

0.61 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

24.39

/report_xls/report_xls.py

# -*- coding: utf-8 -*-
##############################################################################
#
#    OpenERP, Open Source Management Solution
#
#    Copyright (c) 2014 Noviat nv/sa (www.noviat.com). All rights reserved.
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU Affero General Public License as
#    published by the Free Software Foundation, either version 3 of the
#    License, or (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
#    GNU Affero General Public License for more details.
#
#    You should have received a copy of the GNU Affero General Public License
#    along with this program. If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################

import cStringIO
from datetime import datetime
from openerp.osv.fields import datetime as datetime_field
from openerp.tools import DEFAULT_SERVER_DATETIME_FORMAT
import inspect
from types import CodeType
from openerp.report.report_sxw import report_sxw
from openerp import pooler
import logging

_logger = logging.getLogger(__name__)

xls_types_default = {
    'bool': False,
    'date': None,
    'text': '',
    'number': 0,
}

try:
    import xlwt
    from xlwt.Style import default_style

    xls_types = {
        'bool': xlwt.Row.set_cell_boolean,
        'date': xlwt.Row.set_cell_date,
        'text': xlwt.Row.set_cell_text,
        'number': xlwt.Row.set_cell_number,
    }
except ImportError:
    _logger.debug("Cannot import xlwt. This module will not be functional.")
    xls_types = xls_types_default


class AttrDict(dict):
    def __init__(self, *args, **kwargs):
        super(AttrDict, self).__init__(*args, **kwargs)
        self.__dict__ = self


class report_xls(report_sxw):
    # TO DO: move parameters infra to configurable data
    # header/footer
    hf_params = {
        'font_size': 8,
        'font_style': 'I',  # B: Bold, I:  Italic, U: Underline
    }

    # styles
    _pfc = '26'  # default pattern fore_color
    _bc = '22'   # borders color
    decimal_format = '#,##0.00'
    date_format = 'YYYY-MM-DD'
    xls_styles = {
        'xls_title': 'font: bold true, height 240;',
        'bold': 'font: bold true;',
        'underline': 'font: underline true;',
        'italic': 'font: italic true;',
        'fill': 'pattern: pattern solid, fore_color %s;' % _pfc,
        'fill_blue': 'pattern: pattern solid, fore_color 27;',
        'fill_grey': 'pattern: pattern solid, fore_color 22;',
        'borders_all':
            'borders: '
            'left thin, right thin, top thin, bottom thin, '
            'left_colour %s, right_colour %s, '
            'top_colour %s, bottom_colour %s;'
            % (_bc, _bc, _bc, _bc),
        'left': 'align: horz left;',
        'center': 'align: horz center;',
        'right': 'align: horz right;',
        'wrap': 'align: wrap true;',
        'top': 'align: vert top;',
        'bottom': 'align: vert bottom;',
    }
    # TO DO: move parameters supra to configurable data

    def create(self, cr, uid, ids, data, context=None):
        self.pool = pooler.get_pool(cr.dbname)
        self.cr = cr
        self.uid = uid
        report_obj = self.pool.get('ir.actions.report.xml')
        report_ids = report_obj.search(
            cr, uid, [('report_name', '=', self.name[7:])], context=context)
        if report_ids:
            report_xml = report_obj.browse(
                cr, uid, report_ids[0], context=context)
            self.title = report_xml.name
            if report_xml.report_type == 'xls':
                return self.create_source_xls(cr, uid, ids, data, context)
        elif context.get('xls_export'):
            # use model from 'data' when no ir.actions.report.xml entry
            self.table = data.get('model') or self.table
            return self.create_source_xls(cr, uid, ids, data, context)
        return super(report_xls, self).create(cr, uid, ids, data, context)

    def create_source_xls(self, cr, uid, ids, data, context=None):
        if not context:
            context = {}
        parser_instance = self.parser(cr, uid, self.name2, context)
        self.parser_instance = parser_instance
        self.context = context
        objs = self.getObjects(cr, uid, ids, context)
        parser_instance.set_context(objs, data, ids, 'xls')
        objs = parser_instance.localcontext['objects']
        n = cStringIO.StringIO()
        # prevent style make error
        # http://stackoverflow.com/questions/17130516/xlwt-set-style-making-error-more-than-4094-xfs-styles
        wb = xlwt.Workbook(encoding='utf-8', style_compression=2)
        _p = AttrDict(parser_instance.localcontext)
        _xs = self.xls_styles
        self.xls_headers = {
            'standard': '',
        }
        report_date = datetime_field.context_timestamp(
            cr, uid, datetime.now(), context)
        report_date = report_date.strftime(DEFAULT_SERVER_DATETIME_FORMAT)
        self.xls_footers = {
            'standard': (
                '&L&%(font_size)s&%(font_style)s' + report_date +
                '&R&%(font_size)s&%(font_style)s&P / &N'
                ) % self.hf_params,
        }
        self.generate_xls_report(_p, _xs, data, objs, wb)
        wb.save(n)
        n.seek(0)
        return (n.read(), 'xls')

    def render(self, wanted, col_specs, rowtype, render_space='empty'):
        """
        returns 'evaluated' col_specs

        Input:
        - wanted: element from the wanted_list
        - col_specs : cf. specs[1:] documented in xls_row_template method
        - rowtype : 'header' or 'data'
        - render_space : type dict, (caller_space + localcontext)
                         if not specified
        """
        if render_space == 'empty':
            render_space = {}
            caller_space = inspect.currentframe().f_back.f_back.f_locals
            localcontext = self.parser_instance.localcontext
            render_space.update(caller_space)
            render_space.update(localcontext)
        row = col_specs[wanted][rowtype][:]
        for i in range(len(row)):
            if isinstance(row[i], CodeType):
                # TODO Use safe_eval or document why not and remove pylint hack
                row[i] = eval(row[i], render_space)  # pylint: disable=W0123
        row.insert(0, wanted)
        return row

    def generate_xls_report(self, parser, xls_styles, data, objects, wb):
        """ override this method to create your excel file """
        raise NotImplementedError()

    def xls_row_template(self, specs, wanted_list):
        """
        Returns a row template.

        Input :
        - 'wanted_list': list of Columns that will be returned in the
                         row_template
        - 'specs': list with Column Characteristics
            0: Column Name (from wanted_list)
            1: Column Colspan
            2: Column Size (unit = the width of the character ’0′
                            as it appears in the sheet’s default font)
            3: Column Type
            4: Column Data
            5: Column Formula (or 'None' for Data)
            6: Column Style
        """
        r = []
        col = 0
        for w in wanted_list:
            found = False
            for s in specs:
                if s[0] == w:
                    found = True
                    s_len = len(s)
                    c = list(s[:5])
                    # set write_cell_func or formula
                    if s_len > 5 and s[5] is not None:
                        c.append({'formula': s[5]})
                    else:
                        c.append({
                            'write_cell_func': report_xls.xls_types[c[3]]})
                    # Set custom cell style
                    if s_len > 6 and s[6] is not None:
                        c.append(s[6])
                    else:
                        c.append(None)
                    # Set cell formula
                    if s_len > 7 and s[7] is not None:
                        c.append(s[7])
                    else:
                        c.append(None)
                    r.append((col, c[1], c))
                    col += c[1]
                    break
            if not found:
                _logger.warn("report_xls.xls_row_template, "
                             "column '%s' not found in specs", w)
        return r

    def xls_write_row(self, ws, row_pos, row_data,
                      row_style=default_style, set_column_size=False):
        r = ws.row(row_pos)
        for col, size, spec in row_data:
            data = spec[4]
            formula = spec[5].get('formula') and \
                xlwt.Formula(spec[5]['formula']) or None
            style = spec[6] and spec[6] or row_style
            if not data:
                # if no data, use default values
                data = report_xls.xls_types_default[spec[3]]
            if size != 1:
                if formula:
                    ws.write_merge(
                        row_pos, row_pos, col, col + size - 1, data, style)
                else:
                    ws.write_merge(
                        row_pos, row_pos, col, col + size - 1, data, style)
            else:
                if formula:
                    ws.write(row_pos, col, formula, style)
                else:
                    spec[5]['write_cell_func'](r, col, data, style)
            if set_column_size:
                ws.col(col).width = spec[2] * 256
        return row_pos + 1

1	# -- coding: utf-8 --
2	##############################################################################
3	#
4	# OpenERP, Open Source Management Solution
5	#
6	# Copyright (c) 2014 Noviat nv/sa (www.noviat.com). All rights reserved.
7	#
8	# This program is free software: you can redistribute it and/or modify
9	# it under the terms of the GNU Affero General Public License as
10	# published by the Free Software Foundation, either version 3 of the
11	# License, or (at your option) any later version.
12	#
13	# This program is distributed in the hope that it will be useful,
14	# but WITHOUT ANY WARRANTY; without even the implied warranty of
15	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16	# GNU Affero General Public License for more details.
17	#
18	# You should have received a copy of the GNU Affero General Public License
19	# along with this program. If not, see <http://www.gnu.org/licenses/>.
20	#
21	##############################################################################
22
23	import cStringIO	2✔
24	from datetime import datetime	2✔
25	from openerp.osv.fields import datetime as datetime_field	2✔
26	from openerp.tools import DEFAULT_SERVER_DATETIME_FORMAT	2✔
27	import inspect	2✔
28	from types import CodeType	2✔
29	from openerp.report.report_sxw import report_sxw	2✔
30	from openerp import pooler	2✔
31	import logging	2✔
32
33	_logger = logging.getLogger(__name__)	2✔
34
35	xls_types_default = {	2✔
36	'bool': False,
37	'date': None,
38	'text': '',
39	'number': 0,
40	}
41
42	try:	2✔
43	import xlwt	2✔
44	from xlwt.Style import default_style	2✔
45
46	xls_types = {	2✔
47	'bool': xlwt.Row.set_cell_boolean,
48	'date': xlwt.Row.set_cell_date,
49	'text': xlwt.Row.set_cell_text,
50	'number': xlwt.Row.set_cell_number,
51	}
52	except ImportError:	×
53	_logger.debug("Cannot import xlwt. This module will not be functional.")	×
54	xls_types = xls_types_default	×
55
56
57	class AttrDict(dict):	2✔
58	def __init__(self, args, *kwargs):	2✔
59	super(AttrDict, self).__init__(args, *kwargs)	×
60	self.__dict__ = self	×
61
62
63	class report_xls(report_sxw):	2✔
64	# TO DO: move parameters infra to configurable data
65	# header/footer
66	hf_params = {	2✔
67	'font_size': 8,
68	'font_style': 'I', # B: Bold, I: Italic, U: Underline
69	}
70
71	# styles
72	_pfc = '26' # default pattern fore_color	2✔
73	_bc = '22' # borders color	2✔
74	decimal_format = '#,##0.00'	2✔
75	date_format = 'YYYY-MM-DD'	2✔
76	xls_styles = {	2✔
77	'xls_title': 'font: bold true, height 240;',
78	'bold': 'font: bold true;',
79	'underline': 'font: underline true;',
80	'italic': 'font: italic true;',
81	'fill': 'pattern: pattern solid, fore_color %s;' % _pfc,
82	'fill_blue': 'pattern: pattern solid, fore_color 27;',
83	'fill_grey': 'pattern: pattern solid, fore_color 22;',
84	'borders_all':
85	'borders: '
86	'left thin, right thin, top thin, bottom thin, '
87	'left_colour %s, right_colour %s, '
88	'top_colour %s, bottom_colour %s;'
89	% (_bc, _bc, _bc, _bc),
90	'left': 'align: horz left;',
91	'center': 'align: horz center;',
92	'right': 'align: horz right;',
93	'wrap': 'align: wrap true;',
94	'top': 'align: vert top;',
95	'bottom': 'align: vert bottom;',
96	}
97	# TO DO: move parameters supra to configurable data
98
99	def create(self, cr, uid, ids, data, context=None):	2✔
100	self.pool = pooler.get_pool(cr.dbname)	×
101	self.cr = cr	×
102	self.uid = uid	×
103	report_obj = self.pool.get('ir.actions.report.xml')	×
104	report_ids = report_obj.search(	×
105	cr, uid, [('report_name', '=', self.name[7:])], context=context)
106	if report_ids:	×
107	report_xml = report_obj.browse(	×
108	cr, uid, report_ids[0], context=context)
109	self.title = report_xml.name	×
110	if report_xml.report_type == 'xls':	×
111	return self.create_source_xls(cr, uid, ids, data, context)	×
112	elif context.get('xls_export'):	×
113	# use model from 'data' when no ir.actions.report.xml entry
114	self.table = data.get('model') or self.table	×
115	return self.create_source_xls(cr, uid, ids, data, context)	×
116	return super(report_xls, self).create(cr, uid, ids, data, context)	×
117
118	def create_source_xls(self, cr, uid, ids, data, context=None):	2✔
119	if not context:	×
120	context = {}	×
121	parser_instance = self.parser(cr, uid, self.name2, context)	×
122	self.parser_instance = parser_instance	×
123	self.context = context	×
124	objs = self.getObjects(cr, uid, ids, context)	×
125	parser_instance.set_context(objs, data, ids, 'xls')	×
126	objs = parser_instance.localcontext['objects']	×
127	n = cStringIO.StringIO()	×
128	# prevent style make error
129	# http://stackoverflow.com/questions/17130516/xlwt-set-style-making-error-more-than-4094-xfs-styles
130	wb = xlwt.Workbook(encoding='utf-8', style_compression=2)	×
131	_p = AttrDict(parser_instance.localcontext)	×
132	_xs = self.xls_styles	×
133	self.xls_headers = {	×
134	'standard': '',
135	}
136	report_date = datetime_field.context_timestamp(	×
137	cr, uid, datetime.now(), context)
138	report_date = report_date.strftime(DEFAULT_SERVER_DATETIME_FORMAT)	×
139	self.xls_footers = {	×
140	'standard': (
141	'&L&%(font_size)s&%(font_style)s' + report_date +
142	'&R&%(font_size)s&%(font_style)s&P / &N'
143	) % self.hf_params,
144	}
145	self.generate_xls_report(_p, _xs, data, objs, wb)	×
146	wb.save(n)	×
147	n.seek(0)	×
148	return (n.read(), 'xls')	×
149
150	def render(self, wanted, col_specs, rowtype, render_space='empty'):	2✔
151	"""
152	returns 'evaluated' col_specs
153
154	Input:
155	- wanted: element from the wanted_list
156	- col_specs : cf. specs[1:] documented in xls_row_template method
157	- rowtype : 'header' or 'data'
158	- render_space : type dict, (caller_space + localcontext)
159	if not specified
160	"""
161	if render_space == 'empty':	×
162	render_space = {}	×
163	caller_space = inspect.currentframe().f_back.f_back.f_locals	×
164	localcontext = self.parser_instance.localcontext	×
165	render_space.update(caller_space)	×
166	render_space.update(localcontext)	×
167	row = col_specs[wanted][rowtype][:]	×
168	for i in range(len(row)):	×
169	if isinstance(row[i], CodeType):	×
170	# TODO Use safe_eval or document why not and remove pylint hack
171	row[i] = eval(row[i], render_space) # pylint: disable=W0123	×
172	row.insert(0, wanted)	×
173	return row	×
174
175	def generate_xls_report(self, parser, xls_styles, data, objects, wb):	2✔
176	""" override this method to create your excel file """
177	raise NotImplementedError()	×
178
179	def xls_row_template(self, specs, wanted_list):	2✔
180	"""
181	Returns a row template.
182
183	Input :
184	- 'wanted_list': list of Columns that will be returned in the
185	row_template
186	- 'specs': list with Column Characteristics
187	0: Column Name (from wanted_list)
188	1: Column Colspan
189	2: Column Size (unit = the width of the character ’0′
190	as it appears in the sheet’s default font)
191	3: Column Type
192	4: Column Data
193	5: Column Formula (or 'None' for Data)
194	6: Column Style
195	"""
196	r = []	×
197	col = 0	×
198	for w in wanted_list:	×
199	found = False	×
200	for s in specs:	×
201	if s[0] == w:	×
202	found = True	×
203	s_len = len(s)	×
204	c = list(s[:5])	×
205	# set write_cell_func or formula
206	if s_len > 5 and s[5] is not None:	×
207	c.append({'formula': s[5]})	×
208	else:
209	c.append({	×
210	'write_cell_func': report_xls.xls_types[c[3]]})
211	# Set custom cell style
212	if s_len > 6 and s[6] is not None:	×
213	c.append(s[6])	×
214	else:
215	c.append(None)	×
216	# Set cell formula
217	if s_len > 7 and s[7] is not None:	×
218	c.append(s[7])	×
219	else:
220	c.append(None)	×
221	r.append((col, c[1], c))	×
222	col += c[1]	×
223	break	×
224	if not found:	×
225	_logger.warn("report_xls.xls_row_template, "	×
226	"column '%s' not found in specs", w)
227	return r	×
228
229	def xls_write_row(self, ws, row_pos, row_data,	2✔
230	row_style=default_style, set_column_size=False):
231	r = ws.row(row_pos)	×
232	for col, size, spec in row_data:	×
233	data = spec[4]	×
234	formula = spec[5].get('formula') and \	×
235	xlwt.Formula(spec[5]['formula']) or None
236	style = spec[6] and spec[6] or row_style	×
237	if not data:	×
238	# if no data, use default values
239	data = report_xls.xls_types_default[spec[3]]	×
240	if size != 1:	×
241	if formula:	×
242	ws.write_merge(	×
243	row_pos, row_pos, col, col + size - 1, data, style)
244	else:
245	ws.write_merge(	×
246	row_pos, row_pos, col, col + size - 1, data, style)
247	else:
248	if formula:	×
249	ws.write(row_pos, col, formula, style)	×
250	else:
251	spec[5]['write_cell_func'](r, col, data, style)	×
252	if set_column_size:	×
253	ws.col(col).width = spec[2] * 256	×
254	return row_pos + 1	×

OCA / reporting-engine / 171

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous