[IMP] report_csv: pre-commit auto fixes

Author: victoralmau

report_csv/README.rst

@@ -17,13 +17,13 @@ Base report csv
     :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_csv
+    :target: https://github.com/OCA/reporting-engine/tree/17.0/report_csv
     :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_csv
+    :target: https://translation.odoo-community.org/projects/reporting-engine-17-0/reporting-engine-17-0-report_csv
     :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
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=17.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
@@ -38,57 +38,65 @@ This module provides a basic report class to generate csv report.
 Configuration
 =============
 
-In case the exported CSV report should be encoded in another system than UTF-8, following
-fields of the report record (*Settings > Technical > Reports*) should be populated accordingly.
+In case the exported CSV report should be encoded in another system than
+UTF-8, following fields of the report record (*Settings > Technical >
+Reports*) should be populated accordingly.
 
-* Encoding: set an encoding system (such as cp932)
-* Encode Error Handling: select 'Ignore' or 'Replace' as necessary.
+-  Encoding: set an encoding system (such as cp932)
+-  Encode Error Handling: select 'Ignore' or 'Replace' as necessary.
 
-  * 'Ignore': in case of an encoding error, the problematic character will be removed from the exported file.
-  * 'Replace': in case of an encoding error, the problematic character will be replaced with '?' symbol.
-  * Leaving the field blank: in case of an encoding error, the report generation fails with an error message.
+   -  'Ignore': in case of an encoding error, the problematic character
+      will be removed from the exported file.
+   -  'Replace': in case of an encoding error, the problematic character
+      will be replaced with '?' symbol.
+   -  Leaving the field blank: in case of an encoding error, the report
+      generation fails with an error message.
 
 Usage
 =====
 
-An example of CSV report for partners on a module called `module_name`:
+An example of CSV report for partners on a module called
+\`module_name\`:
 
-A python class ::
+A python class :
 
-    from odoo import models
+::
 
-    class PartnerCSV(models.AbstractModel):
-        _name = 'report.report_csv.partner_csv'
-        _inherit = 'report.report_csv.abstract'
+   from odoo import models
 
-        def generate_csv_report(self, writer, data, partners):
-            writer.writeheader()
-            for obj in partners:
-                writer.writerow({
-                    'name': obj.name,
-                    'email': obj.email,
-                })
+   class PartnerCSV(models.AbstractModel):
+       _name = 'report.report_csv.partner_csv'
+       _inherit = 'report.report_csv.abstract'
 
-        def csv_report_options(self):
-            res = super().csv_report_options()
-            res['fieldnames'].append('name')
-            res['fieldnames'].append('email')
-            res['delimiter'] = ';'
-            res['quoting'] = csv.QUOTE_ALL
-            return res
+       def generate_csv_report(self, writer, data, partners):
+           writer.writeheader()
+           for obj in partners:
+               writer.writerow({
+                   'name': obj.name,
+                   'email': obj.email,
+               })
 
+       def csv_report_options(self):
+           res = super().csv_report_options()
+           res['fieldnames'].append('name')
+           res['fieldnames'].append('email')
+           res['delimiter'] = ';'
+           res['quoting'] = csv.QUOTE_ALL
+           return res
 
-A report XML record ::
+A report XML record :
 
-    <report
-        id="partner_csv"
-        model="res.partner"
-        string="Print to CSV"
-        report_type="csv"
-        name="module_name.report_name"
-        file="res_partner"
-        attachment_use="False"
-    />
+::
+
+   <report
+       id="partner_csv"
+       model="res.partner"
+       string="Print to CSV"
+       report_type="csv"
+       name="module_name.report_name"
+       file="res_partner"
+       attachment_use="False"
+   />
 
 Update encoding with an appropriate value (e.g. cp932) as necessary.
 
@@ -98,30 +106,30 @@ 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 to smash it by providing a detailed and welcomed
-`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_csv%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_csv%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
 Do not contact contributors directly about support or help with technical issues.
 
 Credits
 =======
 
 Authors
-~~~~~~~
+-------
 
 * Creu Blanca
 
 Contributors
-~~~~~~~~~~~~
+------------
 
-* Enric Tobella <etobella@creublanca.es>
-* Jaime Arroyo <jaime.arroyo@creublanca.es>
-* Rattapong Chokmasermkul <rattapongc@ecosoft.co.th>
-* `Quartile <https://www.quartile.co>`__:
+-  Enric Tobella <etobella@creublanca.es>
+-  Jaime Arroyo <jaime.arroyo@creublanca.es>
+-  Rattapong Chokmasermkul <rattapongc@ecosoft.co.th>
+-  `Quartile <https://www.quartile.co>`__:
 
-  * Aung Ko Ko Lin
+   -  Aung Ko Ko Lin
 
 Maintainers
-~~~~~~~~~~~
+-----------
 
 This module is maintained by the OCA.
 
@@ -133,6 +141,6 @@ 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 <https://github.com/OCA/reporting-engine/tree/16.0/report_csv>`_ project on GitHub.
+This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/17.0/report_csv>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

report_csv/controllers/main.py

@@ -11,6 +11,8 @@
     content_disposition,
     request,
     route,
+)
+from odoo.http import (
     serialize_exception as _serialize_exception,
 )
 from odoo.tools import html_escape
@@ -47,9 +49,7 @@ def report_routes(self, reportname, docids=None, converter=None, **data):
                 ("Content-Length", len(csv)),
             ]
             return request.make_response(csv, headers=csvhttpheaders)
-        return super(ReportController, self).report_routes(
-            reportname, docids, converter, **data
-        )
+        return super().report_routes(reportname, docids, converter, **data)
 
     @route()
     def report_download(self, data, context=None):
@@ -73,8 +73,9 @@ def report_download(self, data, context=None):
                         url_decode(url.split("?")[1]).items()
                     )  # decoding the args represented in JSON
                     if "context" in data:
-                        context, data_context = json.loads(context or "{}"), json.loads(
-                            data.pop("context")
+                        context, data_context = (
+                            json.loads(context or "{}"),
+                            json.loads(data.pop("context")),
                         )
                         context = json.dumps({**context, **data_context})
                     response = self.report_routes(
@@ -99,7 +100,7 @@ def report_download(self, data, context=None):
                 )
                 return response
             else:
-                return super(ReportController, self).report_download(data, context)
+                return super().report_download(data, context)
         except Exception as e:
             _logger.exception("Error while generating report %s", reportname)
             se = _serialize_exception(e)

report_csv/models/ir_report.py

@@ -80,7 +80,7 @@ def _render_csv(self, report_ref, docids, data):
 
     @api.model
     def _get_report_from_name(self, report_name):
-        res = super(ReportAction, self)._get_report_from_name(report_name)
+        res = super()._get_report_from_name(report_name)
         if res:
             return res
         report_obj = self.env["ir.actions.report"]

report_csv/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

report_csv/readme/CONFIGURE.md

@@ -0,0 +1,12 @@
+In case the exported CSV report should be encoded in another system than
+UTF-8, following fields of the report record (*Settings \> Technical \>
+Reports*) should be populated accordingly.
+
+- Encoding: set an encoding system (such as cp932)
+- Encode Error Handling: select 'Ignore' or 'Replace' as necessary.
+  - 'Ignore': in case of an encoding error, the problematic character
+    will be removed from the exported file.
+  - 'Replace': in case of an encoding error, the problematic character
+    will be replaced with '?' symbol.
+  - Leaving the field blank: in case of an encoding error, the report
+    generation fails with an error message.

report_csv/readme/CONFIGURE.rst

@@ -0,0 +1,5 @@
+- Enric Tobella \<<etobella@creublanca.es>\>
+- Jaime Arroyo \<<jaime.arroyo@creublanca.es>\>
+- Rattapong Chokmasermkul \<<rattapongc@ecosoft.co.th>\>
+- [Quartile](https://www.quartile.co):
+  - Aung Ko Ko Lin

report_csv/readme/CONTRIBUTORS.md

@@ -1,6 +1,7 @@
-An example of CSV report for partners on a module called `module_name`:
+An example of CSV report for partners on a module called
+\`module_name\`:
 
-A python class ::
+A python class :
 
     from odoo import models
 
@@ -24,8 +25,7 @@ A python class ::
             res['quoting'] = csv.QUOTE_ALL
             return res
 
-
-A report XML record ::
+A report XML record :
 
     <report
         id="partner_csv"

report_csv/readme/CONTRIBUTORS.rst

@@ -369,7 +369,7 @@ <h1 class="title">Base report csv</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:a39959a00912416454f8818d70b9a3ffdd305aeb1b1c35ce3ea007f3c41526bd
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/reporting-engine/tree/16.0/report_csv"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/reporting-engine-16-0/reporting-engine-16-0-report_csv"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/reporting-engine/tree/17.0/report_csv"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/reporting-engine-17-0/reporting-engine-17-0-report_csv"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module provides a basic report class to generate csv report.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
@@ -387,22 +387,27 @@ <h1 class="title">Base report csv</h1>
 </div>
 <div class="section" id="configuration">
 <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
-<p>In case the exported CSV report should be encoded in another system than UTF-8, following
-fields of the report record (<em>Settings &gt; Technical &gt; Reports</em>) should be populated accordingly.</p>
+<p>In case the exported CSV report should be encoded in another system than
+UTF-8, following fields of the report record (<em>Settings &gt; Technical &gt;
+Reports</em>) should be populated accordingly.</p>
 <ul class="simple">
 <li>Encoding: set an encoding system (such as cp932)</li>
 <li>Encode Error Handling: select ‘Ignore’ or ‘Replace’ as necessary.<ul>
-<li>‘Ignore’: in case of an encoding error, the problematic character will be removed from the exported file.</li>
-<li>‘Replace’: in case of an encoding error, the problematic character will be replaced with ‘?’ symbol.</li>
-<li>Leaving the field blank: in case of an encoding error, the report generation fails with an error message.</li>
+<li>‘Ignore’: in case of an encoding error, the problematic character
+will be removed from the exported file.</li>
+<li>‘Replace’: in case of an encoding error, the problematic character
+will be replaced with ‘?’ symbol.</li>
+<li>Leaving the field blank: in case of an encoding error, the report
+generation fails with an error message.</li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="section" id="usage">
 <h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
-<p>An example of CSV report for partners on a module called <cite>module_name</cite>:</p>
-<p>A python class</p>
+<p>An example of CSV report for partners on a module called
+`module_name`:</p>
+<p>A python class :</p>
 <pre class="literal-block">
 from odoo import models
 
@@ -426,7 +431,7 @@ <h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
         res['quoting'] = csv.QUOTE_ALL
         return res
 </pre>
-<p>A report XML record</p>
+<p>A report XML record :</p>
 <pre class="literal-block">
 &lt;report
     id=&quot;partner_csv&quot;
@@ -445,7 +450,7 @@ <h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/reporting-engine/issues">GitHub Issues</a>.
 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
-<a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_csv%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_csv%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
@@ -477,7 +482,7 @@ <h2><a class="toc-backref" href="#toc-entry-7">Maintainers</a></h2>
 <p>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.</p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/16.0/report_csv">OCA/reporting-engine</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/17.0/report_csv">OCA/reporting-engine</a> project on GitHub.</p>
 <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
 </div>
 </div>

report_csv/readme/DESCRIPTION.rst report_csv/readme/DESCRIPTION.md

@@ -62,7 +62,6 @@ def test_attachment_use(self):
         self.assertTupleEqual(rep, rep_from_attachment)
 
     def test_id_retrieval(self):
-
         # Typical call from WebUI with wizard
         objs = self.csv_report._get_objs_for_report(
             False, {"context": {"active_ids": self.docs.ids}}