From d4afffff2798209c1a924e4c5aec4aade76d32ee Mon Sep 17 00:00:00 2001 From: Saran440 Date: Thu, 3 Sep 2020 11:15:33 +0700 Subject: [PATCH] [IMP] report_async: black, isort, prettier --- report_async/__manifest__.py | 40 +++-- report_async/data/mail_template.xml | 75 ++++++--- report_async/demo/report_async_demo.xml | 6 +- report_async/models/ir_report.py | 22 ++- report_async/models/report_async.py | 168 +++++++++++--------- report_async/security/ir_rule.xml | 30 ++-- report_async/tests/test_report_async.py | 29 ++-- report_async/views/report_async.xml | 164 ++++++++++++------- report_async/wizard/print_report_wizard.py | 37 +++-- report_async/wizard/print_report_wizard.xml | 22 +-- setup/report_async/odoo/addons/report_async | 1 + setup/report_async/setup.py | 6 + 12 files changed, 343 insertions(+), 257 deletions(-) create mode 120000 setup/report_async/odoo/addons/report_async create mode 100644 setup/report_async/setup.py diff --git a/report_async/__manifest__.py b/report_async/__manifest__.py index 74a9be855..de7444581 100644 --- a/report_async/__manifest__.py +++ b/report_async/__manifest__.py @@ -1,27 +1,23 @@ # Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) { - 'name': 'Report Async', - 'summary': 'Central place to run reports live or async', - 'version': '12.0.1.0.1', - 'author': 'Ecosoft, Odoo Community Association (OCA)', - 'license': 'AGPL-3', - 'website': 'https://github.com/OCA/reporting-engine', - 'category': 'Generic Modules', - 'depends': [ - 'queue_job', + "name": "Report Async", + "summary": "Central place to run reports live or async", + "version": "12.0.1.0.1", + "author": "Ecosoft, Odoo Community Association (OCA)", + "license": "AGPL-3", + "website": "https://github.com/OCA/reporting-engine", + "category": "Generic Modules", + "depends": ["queue_job"], + "data": [ + "security/ir.model.access.csv", + "security/ir_rule.xml", + "data/mail_template.xml", + "views/report_async.xml", + "wizard/print_report_wizard.xml", ], - 'data': [ - 'security/ir.model.access.csv', - 'security/ir_rule.xml', - 'data/mail_template.xml', - 'views/report_async.xml', - 'wizard/print_report_wizard.xml', - ], - 'demo': [ - 'demo/report_async_demo.xml', - ], - 'installable': True, - 'maintainers': ['kittiu'], - 'development_status': 'Beta', + "demo": ["demo/report_async_demo.xml"], + "installable": True, + "maintainers": ["kittiu"], + "development_status": "Beta", } diff --git a/report_async/data/mail_template.xml b/report_async/data/mail_template.xml index 409677e05..77411dc14 100644 --- a/report_async/data/mail_template.xml +++ b/report_async/data/mail_template.xml @@ -1,46 +1,73 @@ - + Report Async: New Report Available - + Your report is available, ${object.name} - ${object.company_id.partner_id.email_formatted|safe} + ${object.company_id.partner_id.email_formatted|safe} ${user.partner_id.id} - - -
- - +
- - -
- - - - -
+ + + + + + +
+ + + - + +
% set base_url = object.env['ir.config_parameter'].sudo().get_param('web.base.url') % set download_url = '%s/web/content/ir.attachment/%s/datas/%s?download=true' % (base_url, object.id, object.name, )
Dear ${object.create_uid.partner_id.name or ''}, -

- Your requested report, ${object.name}, is available for download. -

+

+ Your requested report, ${object.name}, is available for + download + . +

Have a nice day!
- --
${object.company_id.name} + --
${object.company_id.name}
+
-
+
- - + + diff --git a/report_async/demo/report_async_demo.xml b/report_async/demo/report_async_demo.xml index 13e4b602b..1a60a3874 100644 --- a/report_async/demo/report_async_demo.xml +++ b/report_async/demo/report_async_demo.xml @@ -1,9 +1,7 @@ - - - + + - diff --git a/report_async/models/ir_report.py b/report_async/models/ir_report.py index e70988bdd..2c4eb569a 100644 --- a/report_async/models/ir_report.py +++ b/report_async/models/ir_report.py @@ -3,26 +3,22 @@ from odoo import api, models - # Define all supported report_type -REPORT_TYPES = ['qweb-pdf', 'qweb-text', - 'qweb-xml', 'csv', - 'excel', 'xlsx'] +REPORT_TYPES = ["qweb-pdf", "qweb-text", "qweb-xml", "csv", "excel", "xlsx"] class Report(models.Model): - _inherit = 'ir.actions.report' + _inherit = "ir.actions.report" @api.noguess def report_action(self, docids, data=None, config=True): - res = super(Report, self).report_action(docids, data=data, - config=config) - if res['context'].get('async_process', False): - rpt_async_id = res['context']['active_id'] - report_async = self.env['report.async'].browse(rpt_async_id) - if res['report_type'] in REPORT_TYPES: + res = super(Report, self).report_action(docids, data=data, config=config) + if res["context"].get("async_process", False): + rpt_async_id = res["context"]["active_id"] + report_async = self.env["report.async"].browse(rpt_async_id) + if res["report_type"] in REPORT_TYPES: report_async.with_delay().run_report( - res['context'].get('active_ids', []), data, - self.id, self._uid) + res["context"].get("active_ids", []), data, self.id, self._uid + ) return {} return res diff --git a/report_async/models/report_async.py b/report_async/models/report_async.py index 376acc71c..7ece44eb4 100644 --- a/report_async/models/report_async.py +++ b/report_async/models/report_async.py @@ -2,93 +2,98 @@ # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) import base64 -from odoo import api, fields, models, _ -from odoo.tools.safe_eval import safe_eval + +from odoo import _, api, fields, models from odoo.exceptions import UserError +from odoo.tools.safe_eval import safe_eval + from odoo.addons.queue_job.job import job - # Define all supported report_type -REPORT_TYPES_FUNC = {'qweb-pdf': 'render_qweb_pdf', - 'qweb-text': 'render_qweb_text', - 'qweb-xml': 'render_qweb_xml', - 'csv': 'render_csv', - 'excel': 'render_excel', - 'xlsx': 'render_xlsx', } +REPORT_TYPES_FUNC = { + "qweb-pdf": "render_qweb_pdf", + "qweb-text": "render_qweb_text", + "qweb-xml": "render_qweb_xml", + "csv": "render_csv", + "excel": "render_excel", + "xlsx": "render_xlsx", +} class ReportAsync(models.Model): - _name = 'report.async' - _description = 'Report Async' + _name = "report.async" + _description = "Report Async" action_id = fields.Many2one( - comodel_name='ir.actions.act_window', - string='Reports', - required=True, + comodel_name="ir.actions.act_window", string="Reports", required=True, ) allow_async = fields.Boolean( - string='Allow Async', + string="Allow Async", default=False, help="This is not automatic field, please check if you want to allow " "this report in background process", ) - name = fields.Char( - string='Name', - related='action_id.display_name', - ) + name = fields.Char(string="Name", related="action_id.display_name",) email_notify = fields.Boolean( - string='Email Notification', + string="Email Notification", help="Send email with link to report, when it is ready", ) group_ids = fields.Many2many( - string='Groups', - comodel_name='res.groups', + string="Groups", + comodel_name="res.groups", help="Only user in selected groups can use this report." "If left blank, everyone can use", ) job_ids = fields.Many2many( - comodel_name='queue.job', - compute='_compute_job', + comodel_name="queue.job", + compute="_compute_job", help="List all jobs related to this running report", ) job_status = fields.Selection( - selection=[('pending', 'Pending'), - ('enqueued', 'Enqueued'), - ('started', 'Started'), - ('done', 'Done'), - ('failed', 'Failed')], - compute='_compute_job', + selection=[ + ("pending", "Pending"), + ("enqueued", "Enqueued"), + ("started", "Started"), + ("done", "Done"), + ("failed", "Failed"), + ], + compute="_compute_job", help="Latest Job Status", ) - job_info = fields.Text( - compute='_compute_job', - help="Latest Job Error Message", - ) + job_info = fields.Text(compute="_compute_job", help="Latest Job Error Message",) file_ids = fields.Many2many( - comodel_name='ir.attachment', - compute='_compute_file', + comodel_name="ir.attachment", + compute="_compute_file", help="List all files created by this report background process", ) @api.multi def _compute_job(self): for rec in self: - rec.job_ids = self.sudo().env['queue.job'].search( - [('func_string', 'like', 'report.async(%s,)' % rec.id), - ('user_id', '=', self._uid)], - order='id desc') - rec.job_status = (rec.job_ids[0].sudo().state - if rec.job_ids else False) - rec.job_info = (rec.job_ids[0].sudo().exc_info - if rec.job_ids else False) + rec.job_ids = ( + self.sudo() + .env["queue.job"] + .search( + [ + ("func_string", "like", "report.async(%s,)" % rec.id), + ("user_id", "=", self._uid), + ], + order="id desc", + ) + ) + rec.job_status = rec.job_ids[0].sudo().state if rec.job_ids else False + rec.job_info = rec.job_ids[0].sudo().exc_info if rec.job_ids else False @api.multi def _compute_file(self): - files = self.env['ir.attachment'].search( - [('res_model', '=', 'report.async'), - ('res_id', 'in', self.ids), - ('create_uid', '=', self._uid)], - order='id desc') + files = self.env["ir.attachment"].search( + [ + ("res_model", "=", "report.async"), + ("res_id", "in", self.ids), + ("create_uid", "=", self._uid), + ], + order="id desc", + ) for rec in self: rec.file_ids = files.filtered(lambda l: l.res_id == rec.id) @@ -96,67 +101,76 @@ class ReportAsync(models.Model): self.ensure_one() action = self.env.ref(self.action_id.xml_id) result = action.read()[0] - ctx = safe_eval(result.get('context', {})) - ctx.update({'async_process': False}) - result['context'] = ctx + ctx = safe_eval(result.get("context", {})) + ctx.update({"async_process": False}) + result["context"] = ctx return result @api.multi def run_async(self): self.ensure_one() if not self.allow_async: - raise UserError(_('Background process not allowed.')) + raise UserError(_("Background process not allowed.")) action = self.env.ref(self.action_id.xml_id) result = action.read()[0] - ctx = safe_eval(result.get('context', {})) - ctx.update({'async_process': True}) - result['context'] = ctx + ctx = safe_eval(result.get("context", {})) + ctx.update({"async_process": True}) + result["context"] = ctx return result @api.multi def view_files(self): self.ensure_one() - action = self.env.ref('report_async.action_view_files') + action = self.env.ref("report_async.action_view_files") result = action.read()[0] - result['domain'] = [('id', 'in', self.file_ids.ids)] + result["domain"] = [("id", "in", self.file_ids.ids)] return result @api.multi def view_jobs(self): self.ensure_one() - action = self.env.ref('queue_job.action_queue_job') + action = self.env.ref("queue_job.action_queue_job") result = action.read()[0] - result['domain'] = [('id', 'in', self.job_ids.ids)] - result['context'] = {} + result["domain"] = [("id", "in", self.job_ids.ids)] + result["context"] = {} return result @api.model @job def run_report(self, docids, data, report_id, user_id): - report = self.env['ir.actions.report'].browse(report_id) + report = self.env["ir.actions.report"].browse(report_id) func = REPORT_TYPES_FUNC[report.report_type] # Run report out_file, file_ext = getattr(report, func)(docids, data) out_file = base64.b64encode(out_file) - out_name = '%s.%s' % (report.name, file_ext) + out_name = "{}.{}".format(report.name, file_ext) # Save report to attachment - attachment = self.env['ir.attachment'].sudo().create({ - 'name': out_name, - 'datas': out_file, - 'datas_fname': out_name, - 'type': 'binary', - 'res_model': 'report.async', - 'res_id': self.id, - }) - self._cr.execute(""" + attachment = ( + self.env["ir.attachment"] + .sudo() + .create( + { + "name": out_name, + "datas": out_file, + "datas_fname": out_name, + "type": "binary", + "res_model": "report.async", + "res_id": self.id, + } + ) + ) + self._cr.execute( + """ UPDATE ir_attachment SET create_uid = %s, write_uid = %s - WHERE id = %s""", (self._uid, self._uid, attachment.id)) + WHERE id = %s""", + (self._uid, self._uid, attachment.id), + ) # Send email if self.email_notify: self._send_email(attachment) def _send_email(self, attachment): - template = self.env.ref('report_async.async_report_delivery') - template.send_mail(attachment.id, - notif_layout='mail.mail_notification_light', - force_send=False) + template = self.env.ref("report_async.async_report_delivery") + template.send_mail( + attachment.id, notif_layout="mail.mail_notification_light", force_send=False + ) diff --git a/report_async/security/ir_rule.xml b/report_async/security/ir_rule.xml index a1430189c..b551c92cb 100644 --- a/report_async/security/ir_rule.xml +++ b/report_async/security/ir_rule.xml @@ -1,23 +1,25 @@ - + Report Async by Groups - - - - - - - ['|', ('group_ids', '=', False), ('group_ids', 'in', [g.id for g in user.groups_id])] + + + + + + + ['|', ('group_ids', '=', False), ('group_ids', 'in', [g.id for g in user.groups_id])] Report Async by Groups - - - - - - + + + + + + [(1,'=', 1)] diff --git a/report_async/tests/test_report_async.py b/report_async/tests/test_report_async.py index b921534a2..a1f1e8bd0 100644 --- a/report_async/tests/test_report_async.py +++ b/report_async/tests/test_report_async.py @@ -1,26 +1,26 @@ # Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) +from odoo.exceptions import UserError from odoo.tests import common from odoo.tests.common import Form -from odoo.exceptions import UserError class TestJobChannel(common.TransactionCase): - def setUp(self): super(TestJobChannel, self).setUp() - self.print_doc = self.env.ref('report_async.' - 'report_async_print_document') - self.test_rec = self.env.ref('base.module_mail') - self.test_rpt = self.env.ref('base.ir_module_reference_print') + self.print_doc = self.env.ref("report_async." "report_async_print_document") + self.test_rec = self.env.ref("base.module_mail") + self.test_rpt = self.env.ref("base.ir_module_reference_print") def _print_wizard(self, res): - obj = self.env[res['res_model']] - ctx = {'active_model': self.print_doc._name, - 'active_id': self.print_doc.id, } - ctx.update(res['context']) + obj = self.env[res["res_model"]] + ctx = { + "active_model": self.print_doc._name, + "active_id": self.print_doc.id, + } + ctx.update(res["context"]) with Form(obj.with_context(ctx)) as form: - form.reference = '%s,%s' % (self.test_rec._name, self.test_rec.id) + form.reference = "{},{}".format(self.test_rec._name, self.test_rec.id) form.action_report_id = self.test_rpt print_wizard = form.save() return print_wizard @@ -29,19 +29,18 @@ class TestJobChannel(common.TransactionCase): """Run now will return report action as normal""" res = self.print_doc.run_now() report_action = self._print_wizard(res).print_report() - self.assertEquals(report_action['type'], 'ir.actions.report') + self.assertEquals(report_action["type"], "ir.actions.report") def test_2_run_async(self): """Run background will return nothing, job started""" with self.assertRaises(UserError): self.print_doc.run_async() - self.print_doc.write({'allow_async': True, - 'email_notify': True}) + self.print_doc.write({"allow_async": True, "email_notify": True}) res = self.print_doc.run_async() print_wizard = self._print_wizard(res) report_action = print_wizard.print_report() self.assertEquals(report_action, {}) # Do not run report yet - self.assertEquals(self.print_doc.job_status, 'pending') # Job started + self.assertEquals(self.print_doc.job_status, "pending") # Job started # Test produce file (as queue will not run in test mode) docids = [print_wizard.reference.id] data = None diff --git a/report_async/views/report_async.xml b/report_async/views/report_async.xml index f6d5f58f1..15aa2e9c7 100644 --- a/report_async/views/report_async.xml +++ b/report_async/views/report_async.xml @@ -1,104 +1,151 @@ - + - report.async.tree report.async - -