From 706c618c58e5ea70a9295f35e8d1c7aa8ab40b69 Mon Sep 17 00:00:00 2001 From: "matthieu.saison" Date: Thu, 14 Dec 2023 16:34:08 +0100 Subject: [PATCH 1/2] [ADD] report_generate_helper --- report_generate_helper/README.rst | 76 ++++ report_generate_helper/__init__.py | 1 + report_generate_helper/__manifest__.py | 13 + report_generate_helper/models/__init__.py | 1 + .../models/report_helper.py | 30 ++ .../readme/CONTRIBUTORS.rst | 1 + report_generate_helper/readme/DESCRIPTION.rst | 1 + .../static/description/index.html | 424 ++++++++++++++++++ report_generate_helper/tests/__init__.py | 1 + .../tests/test_report_generate_helper.py | 7 + .../odoo/addons/report_generate_helper | 1 + setup/report_generate_helper/setup.py | 6 + 12 files changed, 562 insertions(+) create mode 100644 report_generate_helper/README.rst create mode 100644 report_generate_helper/__init__.py create mode 100644 report_generate_helper/__manifest__.py create mode 100644 report_generate_helper/models/__init__.py create mode 100644 report_generate_helper/models/report_helper.py create mode 100644 report_generate_helper/readme/CONTRIBUTORS.rst create mode 100644 report_generate_helper/readme/DESCRIPTION.rst create mode 100644 report_generate_helper/static/description/index.html create mode 100644 report_generate_helper/tests/__init__.py create mode 100644 report_generate_helper/tests/test_report_generate_helper.py create mode 120000 setup/report_generate_helper/odoo/addons/report_generate_helper create mode 100644 setup/report_generate_helper/setup.py diff --git a/report_generate_helper/README.rst b/report_generate_helper/README.rst new file mode 100644 index 0000000000..44eb87a0b6 --- /dev/null +++ b/report_generate_helper/README.rst @@ -0,0 +1,76 @@ +====================== +Report Generate Helper +====================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:800d294f64e8645f5e8ccc3ae112dc5f17e099e22d0e018b05c1d35e3102ad4e + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github + :target: https://github.com/OCA/reporting-engine/tree/16.0/report_generate_helper + :alt: OCA/reporting-engine +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/reporting-engine-16-0/reporting-engine-16-0-report_generate_helper + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows you to get a report from a record by passing the report name. + +**Table of contents** + +.. contents:: + :local: + +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 to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Akretion + +Contributors +~~~~~~~~~~~~ + +* * Matthieu Saison + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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. + +This module is part of the `OCA/reporting-engine `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/report_generate_helper/__init__.py b/report_generate_helper/__init__.py new file mode 100644 index 0000000000..0650744f6b --- /dev/null +++ b/report_generate_helper/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/report_generate_helper/__manifest__.py b/report_generate_helper/__manifest__.py new file mode 100644 index 0000000000..83e96cef18 --- /dev/null +++ b/report_generate_helper/__manifest__.py @@ -0,0 +1,13 @@ +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +{ + "name": "Report Generate Helper", + "version": "16.0.1.0.0", + "summary": "Helper to easily generate report", + "author": "Akretion, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/reporting-engine", + "license": "AGPL-3", + "category": "Reporting", + "depends": [ + "base", + ], +} diff --git a/report_generate_helper/models/__init__.py b/report_generate_helper/models/__init__.py new file mode 100644 index 0000000000..e3045815c5 --- /dev/null +++ b/report_generate_helper/models/__init__.py @@ -0,0 +1 @@ +from . import report_helper diff --git a/report_generate_helper/models/report_helper.py b/report_generate_helper/models/report_helper.py new file mode 100644 index 0000000000..cd013eb470 --- /dev/null +++ b/report_generate_helper/models/report_helper.py @@ -0,0 +1,30 @@ +# Copyright 2023 Akretion (https://www.akretion.com). +# @author Matthieu SAISON +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo import models +from odoo.tools.safe_eval import safe_eval, time + + +class Base(models.AbstractModel): + _inherit = "base" + + def _get_report_converter(self): + return f"_render_{self.report_type.replace('-', '_')}" + + def get_report(self, report_name): + report = self.env["ir.actions.report"]._get_report(report_name) + + method_name = report._get_report_converter() + method = getattr(self.env["ir.actions.report"].sudo(), method_name) + content, extension = method(report_name, self.ids) + + if report.print_report_name and len(self) == 1: + report_name = safe_eval( + report.print_report_name, {"object": self, "time": time} + ) + else: + report_name = report.name + filename = "%s.%s" % (report_name, extension) + + return filename, content diff --git a/report_generate_helper/readme/CONTRIBUTORS.rst b/report_generate_helper/readme/CONTRIBUTORS.rst new file mode 100644 index 0000000000..434568c321 --- /dev/null +++ b/report_generate_helper/readme/CONTRIBUTORS.rst @@ -0,0 +1 @@ +* * Matthieu Saison \ No newline at end of file diff --git a/report_generate_helper/readme/DESCRIPTION.rst b/report_generate_helper/readme/DESCRIPTION.rst new file mode 100644 index 0000000000..90ac5e5ced --- /dev/null +++ b/report_generate_helper/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +This module allows you to get a report from a record by passing the report name. diff --git a/report_generate_helper/static/description/index.html b/report_generate_helper/static/description/index.html new file mode 100644 index 0000000000..418264c06f --- /dev/null +++ b/report_generate_helper/static/description/index.html @@ -0,0 +1,424 @@ + + + + + + +Report Generate Helper + + + +
+

Report Generate Helper

+ + +

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runboat

+

This module allows you to get a report from a record by passing the report name.

+

Table of contents

+ +
+

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 to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Akretion
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

This module is part of the OCA/reporting-engine project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/report_generate_helper/tests/__init__.py b/report_generate_helper/tests/__init__.py new file mode 100644 index 0000000000..113ab544ff --- /dev/null +++ b/report_generate_helper/tests/__init__.py @@ -0,0 +1 @@ +from . import test_report_generate_helper diff --git a/report_generate_helper/tests/test_report_generate_helper.py b/report_generate_helper/tests/test_report_generate_helper.py new file mode 100644 index 0000000000..7740bd7249 --- /dev/null +++ b/report_generate_helper/tests/test_report_generate_helper.py @@ -0,0 +1,7 @@ +from odoo.tests import common + + +class TestReportLabel(common.TransactionCase): + def test_get_report(self): + module = self.env["ir.module.module"].search([])[1] + self.assertTrue(module.get_report("base.report_irmodulereference")) diff --git a/setup/report_generate_helper/odoo/addons/report_generate_helper b/setup/report_generate_helper/odoo/addons/report_generate_helper new file mode 120000 index 0000000000..e1494ce195 --- /dev/null +++ b/setup/report_generate_helper/odoo/addons/report_generate_helper @@ -0,0 +1 @@ +../../../../report_generate_helper \ No newline at end of file diff --git a/setup/report_generate_helper/setup.py b/setup/report_generate_helper/setup.py new file mode 100644 index 0000000000..28c57bb640 --- /dev/null +++ b/setup/report_generate_helper/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) From 0db02d4be74f3f3d07bf99989b1962504c111ed4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20BEAU?= Date: Mon, 3 Jun 2024 19:03:49 +0200 Subject: [PATCH 2/2] report_generate_helper: change method name, clean code, update doc --- report_generate_helper/models/__init__.py | 3 ++- .../models/{report_helper.py => base.py} | 11 +++++++---- report_generate_helper/models/ir_actions_report.py | 13 +++++++++++++ .../tests/test_report_generate_helper.py | 2 +- 4 files changed, 23 insertions(+), 6 deletions(-) rename report_generate_helper/models/{report_helper.py => base.py} (71%) create mode 100644 report_generate_helper/models/ir_actions_report.py diff --git a/report_generate_helper/models/__init__.py b/report_generate_helper/models/__init__.py index e3045815c5..cb428c1371 100644 --- a/report_generate_helper/models/__init__.py +++ b/report_generate_helper/models/__init__.py @@ -1 +1,2 @@ -from . import report_helper +from . import base +from . import ir_actions_report diff --git a/report_generate_helper/models/report_helper.py b/report_generate_helper/models/base.py similarity index 71% rename from report_generate_helper/models/report_helper.py rename to report_generate_helper/models/base.py index cd013eb470..0ec2ca3075 100644 --- a/report_generate_helper/models/report_helper.py +++ b/report_generate_helper/models/base.py @@ -9,14 +9,17 @@ class Base(models.AbstractModel): _inherit = "base" - def _get_report_converter(self): - return f"_render_{self.report_type.replace('-', '_')}" + def _generate_report(self, report_name): + """ + Generate the report matching the report_name for the self object - def get_report(self, report_name): + The method will return a tuple with the name of the field and the content + return (filename, content) + """ report = self.env["ir.actions.report"]._get_report(report_name) method_name = report._get_report_converter() - method = getattr(self.env["ir.actions.report"].sudo(), method_name) + method = getattr(self.env["ir.actions.report"], method_name) content, extension = method(report_name, self.ids) if report.print_report_name and len(self) == 1: diff --git a/report_generate_helper/models/ir_actions_report.py b/report_generate_helper/models/ir_actions_report.py new file mode 100644 index 0000000000..7ae3c68c72 --- /dev/null +++ b/report_generate_helper/models/ir_actions_report.py @@ -0,0 +1,13 @@ +# Copyright 2024 Akretion (https://www.akretion.com). +# @author Sébastien BEAU +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + + +from odoo import models + + +class IrActionsActions(models.Model): + _inherit = "ir.actions.report" + + def _get_report_converter(self): + return f"_render_{self.report_type.replace('-', '_')}" diff --git a/report_generate_helper/tests/test_report_generate_helper.py b/report_generate_helper/tests/test_report_generate_helper.py index 7740bd7249..9df4f35e3a 100644 --- a/report_generate_helper/tests/test_report_generate_helper.py +++ b/report_generate_helper/tests/test_report_generate_helper.py @@ -4,4 +4,4 @@ class TestReportLabel(common.TransactionCase): def test_get_report(self): module = self.env["ir.module.module"].search([])[1] - self.assertTrue(module.get_report("base.report_irmodulereference")) + self.assertTrue(module._generate_report("base.report_irmodulereference"))