[18.0][MIG] report_py3o

Author: Qlasta

report_py3o/__manifest__.py

@@ -4,7 +4,7 @@
     "name": "Py3o Report Engine",
     "summary": "Reporting engine based on Libreoffice (ODT -> ODT, "
     "ODT -> PDF, ODT -> DOC, ODT -> DOCX, ODS -> ODS, etc.)",
-    "version": "16.0.1.0.6",
+    "version": "18.0.1.0.0",
     "category": "Reporting",
     "license": "AGPL-3",
     "author": "XCG Consulting, ACSONE SA/NV, Odoo Community Association (OCA)",

report_py3o/controllers/main.py

@@ -2,17 +2,18 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
 import json
 import mimetypes
+from urllib.parse import parse_qs
 
 from werkzeug import exceptions
-from werkzeug.urls import url_decode
+from werkzeug.datastructures import MultiDict
 
 from odoo.http import content_disposition, request, route, serialize_exception
 from odoo.tools import html_escape
 
-from odoo.addons.web.controllers.report import ReportController
+from odoo.addons.web.controllers.report import ReportController as ReportControllerBase
 
 
-class ReportController(ReportController):
+class ReportController(ReportControllerBase):
     @route()
     def report_routes(self, reportname, docids=None, converter=None, **data):
         if converter != "py3o":
@@ -41,7 +42,7 @@ def report_routes(self, reportname, docids=None, converter=None, **data):
         if not action_py3o_report:
             raise exceptions.HTTPException(
                 description="Py3o action report not found for report_name "
-                "%s" % reportname
+                f"{reportname}"
             )
         res, filetype = ir_action._render(reportname, docids, data)
         filename = action_py3o_report.gen_report_download_filename(docids, data)
@@ -82,7 +83,7 @@ def report_download(self, data, context=None, token=None):
             else:
                 # Particular report:
                 # decoding the args represented in JSON
-                data = list(url_decode(url.split("?")[1]).items())
+                data = list(MultiDict(parse_qs(url.split("?")[1])).items())
                 response = self.report_routes(
                     reportname, converter="py3o", **dict(data)
                 )

report_py3o/models/py3o_report.py

@@ -10,11 +10,10 @@
 import warnings
 from base64 import b64decode
 from contextlib import closing
+from importlib.resources import files
 from io import BytesIO
 from zipfile import ZIP_DEFLATED, ZipFile
 
-import pkg_resources
-
 from odoo import _, api, fields, models, tools
 from odoo.exceptions import AccessError
 from odoo.tools.safe_eval import safe_eval, time
@@ -129,8 +128,8 @@ def _get_template_from_path(self, tmpl_name):
         flbk_filename = None
         if report_xml.module:
             # if the default is defined
-            flbk_filename = pkg_resources.resource_filename(
-                "odoo.addons.%s" % report_xml.module, tmpl_name
+            flbk_filename = files(f"odoo.addons.{report_xml.module}").joinpath(
+                tmpl_name
             )
         elif self._is_valid_template_path(tmpl_name):
             flbk_filename = os.path.realpath(tmpl_name)
@@ -271,11 +270,7 @@ def _convert_single_report(self, result_path, model_instance, data):
                 result_path, result_filename = os.path.split(result_path)
                 result_path = os.path.join(
                     result_path,
-                    "%s.%s"
-                    % (
-                        os.path.splitext(result_filename)[0],
-                        self.ir_actions_report_id.py3o_filetype,
-                    ),
+                    f"{os.path.splitext(result_filename)[0]}.{self.ir_actions_report_id.py3o_filetype}",
                 )
         return result_path
 
@@ -299,7 +294,7 @@ def _convert_single_report_cmd(
             result_path,
         ]
         if user_installation:
-            cmd.append("-env:UserInstallation=file:%s" % user_installation)
+            cmd.append(f"-env:UserInstallation=file:{user_installation}")
         return cmd
 
     def _get_or_create_single_report(
@@ -368,7 +363,7 @@ def _cleanup_tempfiles(self, temporary_files):
             try:
                 os.unlink(temporary_file)
             except OSError:
-                logger.error("Error when trying to remove file %s" % temporary_file)
+                logger.error(f"Error when trying to remove file {temporary_file}")
 
     def create_report(self, res_ids, data):
         """Override this function to handle our py3o report"""

report_py3o/static/src/js/py3oactionservice.esm.js

@@ -10,9 +10,10 @@ registry
             let url = `/report/py3o/${action.report_name}`;
             const actionContext = action.context || {};
             if (
-                _.isUndefined(action.data) ||
-                _.isNull(action.data) ||
-                (_.isObject(action.data) && _.isEmpty(action.data))
+                action.data === undefined ||
+                action.data === null ||
+                (typeof action.data === "object" &&
+                    Object.keys(action.data).length === 0)
             ) {
                 // Build a query string with `action.data` (it's the place where reports
                 // using a wizard to customize the output traditionally put their options)
@@ -33,7 +34,7 @@ registry
                     url: "/report/download",
                     data: {
                         data: JSON.stringify([url, action.report_type]),
-                        context: JSON.stringify(env.services.user.context),
+                        context: JSON.stringify(action.context),
                     },
                 });
             } finally {

report_py3o/tests/test_report_py3o.py

@@ -8,11 +8,17 @@
 import tempfile
 from base64 import b64decode, b64encode
 from contextlib import contextmanager
+from importlib.resources import as_file, files
 from unittest import mock
 
-import pkg_resources
 from PyPDF2 import PdfFileWriter
-from PyPDF2.pdf import PageObject
+
+try:
+    # For PyPDF2 <= 1.26.0
+    from PyPDF2.pdf import PageObject
+except ImportError:
+    # For PyPDF2 >= 2.0.0
+    from PyPDF2 import PageObject
 
 from odoo import tools
 from odoo.exceptions import ValidationError
@@ -44,12 +50,13 @@ def temporary_copy(path):
 
 
 class TestReportPy3o(TransactionCase):
-    def setUp(self):
-        super(TestReportPy3o, self).setUp()
-        self.env.user.image_1920 = PNG
-        self.report = self.env.ref("report_py3o.res_users_report_py3o")
-        self.py3o_report = self.env["py3o.report"].create(
-            {"ir_actions_report_id": self.report.id}
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.env.user.image_1920 = PNG
+        cls.report = cls.env.ref("report_py3o.res_users_report_py3o")
+        cls.py3o_report = cls.env["py3o.report"].create(
+            {"ir_actions_report_id": cls.report.id}
         )
 
     def test_required_py3_filetype(self):
@@ -146,10 +153,9 @@ def test_report_template_configs(self):
         # the demo template is specified with a relative path in in the module
         # path
         tmpl_name = self.report.py3o_template_fallback
-        flbk_filename = pkg_resources.resource_filename(
-            "odoo.addons.%s" % self.report.module, tmpl_name
-        )
-        self.assertTrue(os.path.exists(flbk_filename))
+        with as_file(files(f"odoo.addons.{self.report.module}")) as _asf:
+            flbk_filename = _asf.joinpath(tmpl_name)
+        self.assertTrue(flbk_filename.is_file())
         res = self.report._render(self.report.id, self.env.user.ids)
         self.assertTrue(res)
         # The generation fails if the template is not found
@@ -190,9 +196,8 @@ def test_report_template_configs(self):
     @tools.misc.mute_logger("odoo.addons.report_py3o.models.py3o_report")
     def test_report_template_fallback_validity(self):
         tmpl_name = self.report.py3o_template_fallback
-        flbk_filename = pkg_resources.resource_filename(
-            "odoo.addons.%s" % self.report.module, tmpl_name
-        )
+        with as_file(files(f"odoo.addons.{self.report.module}")) as _asf:
+            flbk_filename = _asf.joinpath(tmpl_name)
         # an exising file in a native format is a valid template if it's
         self.assertTrue(self.py3o_report._get_template_from_path(tmpl_name))
         self.report.module = None
@@ -208,7 +213,7 @@ def test_report_template_fallback_validity(self):
             self.assertTrue(self.py3o_report._get_template_from_path(tmp_filename))
         # check security
         self.assertFalse(
-            self.py3o_report._get_template_from_path("rm -rf . & %s" % flbk_filename)
+            self.py3o_report._get_template_from_path(f"rm -rf . & {flbk_filename}")
         )
         # a file in a non native LibreOffice format is not a valid template
         with tempfile.NamedTemporaryFile(suffix=".toto") as f:

report_py3o/views/ir_actions_report.xml

@@ -6,22 +6,20 @@
         <field name="model">ir.actions.report</field>
         <field name="inherit_id" ref="base.act_report_xml_view" />
         <field name="arch" type="xml">
-            <xpath expr="/form/field[1]" position="before">
+            <xpath expr="//sheet" position="before">
                 <field name="is_py3o_report_not_available" invisible="1" />
-                <div
-                    class="alert alert-danger"
-                    role="alert"
-                    style="margin-bottom:0px;"
-                    attrs="{'invisible': [('is_py3o_report_not_available','=',False)]}"
-                >
-                    <field name="msg_py3o_report_not_available" />
+                <div class="alert alert-danger" role="alert" style="margin-bottom:0px;">
+                    <field
+                        name="msg_py3o_report_not_available"
+                        invisible="not is_py3o_report_not_available"
+                    />
                 </div>
             </xpath>
             <xpath expr="//page[@name='security']" position="before">
                 <page
                     string="LibreOffice Template"
                     name="py3o_tab"
-                    attrs="{'invisible': [('report_type', '!=', 'py3o')]}"
+                    invisible="report_type != 'py3o'"
                 >
                     <group name="py3o_params">
                         <field name="lo_bin_path" />

report_py3o/views/py3o_template.xml

@@ -31,19 +31,19 @@
         </field>
     </record>
     <record id="py3o_template_configuration_tree_view" model="ir.ui.view">
-        <field name="name">py3o.template.configuration.tree.view</field>
+        <field name="name">py3o.template.configuration.list.view</field>
         <field name="model">py3o.template</field>
         <field name="arch" type="xml">
-            <tree>
+            <list>
                 <field name="name" />
                 <field name="filetype" />
-            </tree>
+            </list>
         </field>
     </record>
     <record id="py3o_template_configuration_action" model="ir.actions.act_window">
         <field name="name">Py3o Templates</field>
         <field name="res_model">py3o.template</field>
-        <field name="view_mode">tree,form</field>
+        <field name="view_mode">list,form</field>
     </record>
     <menuitem
         id="py3o_template_configuration_menu"