[IMP] rest_log: pre-commit auto fixes

glitchov · glitchov · commit 39c2fb7b4768 · 2025-03-14T08:46:49.000+01:00
diff --git a/rest_log/README.rst b/rest_log/README.rst
@@ -17,26 +17,26 @@ REST Log
     :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
     :alt: License: LGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github
-    :target: https://github.com/OCA/rest-framework/tree/16.0/rest_log
+    :target: https://github.com/OCA/rest-framework/tree/18.0/rest_log
     :alt: OCA/rest-framework
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/rest-framework-16-0/rest-framework-16-0-rest_log
+    :target: https://translation.odoo-community.org/projects/rest-framework-18-0/rest-framework-18-0-rest_log
     :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/rest-framework&target_branch=16.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&target_branch=18.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
 When exposing REST services is often useful to see what's happening
 especially in case of errors.
 
-This module add DB logging for REST requests.
-It also inject in the response the URL of the log entry created.
+This module add DB logging for REST requests. It also inject in the
+response the URL of the log entry created.
 
-NOTE: this feature was implemented initially inside shopfloor app.
-Up to version 13.0.1.2.1 of this module,
-if shopfloor is installed, log records will be copied from its table.
+NOTE: this feature was implemented initially inside shopfloor app. Up to
+version 13.0.1.2.1 of this module, if shopfloor is installed, log
+records will be copied from its table.
 
 **Table of contents**
 
@@ -47,44 +47,48 @@ Configuration
 =============
 
 Logs retention
-~~~~~~~~~~~~~~
+--------------
 
-Logs are kept in database for every REST requests made by a client application.
-They can be used for debugging and monitoring of the activity.
+Logs are kept in database for every REST requests made by a client
+application. They can be used for debugging and monitoring of the
+activity.
 
-The Logs menu is shown only with Developer tools (``?debug=1``) activated.
+The Logs menu is shown only with Developer tools (``?debug=1``)
+activated.
 
-By default, REST logs are kept 30 days.
-You can change the duration of the retention by changing the System Parameter
+By default, REST logs are kept 30 days. You can change the duration of
+the retention by changing the System Parameter
 ``rest.log.retention.days``.
 
 If the value is set to 0, the logs are not stored at all.
 
-Logged data is: request URL and method, parameters, headers, result or error.
-
+Logged data is: request URL and method, parameters, headers, result or
+error.
 
 Logs activation
-~~~~~~~~~~~~~~~
+---------------
 
 You have 2 ways to activate logging:
 
-* on the service component set `_log_calls_in_db = True`
-* via configuration
+- on the service component set \_log_calls_in_db = True
+- via configuration
 
 In the 1st case, calls will be always be logged.
 
-In the 2nd case you can set ``rest.log.active`` param as::
+In the 2nd case you can set ``rest.log.active`` param as:
+
+::
 
-    `collection_name`  # enable for all endpoints of the collection
-    `collection_name.usage`  # enable for specific endpoints
-    `collection_name.usage.endpoint`  # enable for specific endpoints
-    `collection_name*:state`  # enable only for specific state (success, failed)
+   `collection_name`  # enable for all endpoints of the collection
+   `collection_name.usage`  # enable for specific endpoints
+   `collection_name.usage.endpoint`  # enable for specific endpoints
+   `collection_name*:state`  # enable only for specific state (success, failed)
 
 Changelog
 =========
 
 13.0.1.0.0
-~~~~~~~~~~
+----------
 
 First official version.
 
@@ -94,36 +98,36 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/rest-framework/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/rest-framework/issues/new?body=module:%20rest_log%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/rest-framework/issues/new?body=module:%20rest_log%0Aversion:%2018.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
-~~~~~~~
+-------
 
 * Camptocamp
 * ACSONE
 
 Contributors
-~~~~~~~~~~~~
+------------
 
-* Guewen Baconnier <guewen.baconnier@camptocamp.com>
-* Simone Orsi <simahawk@gmail.com>
+- Guewen Baconnier <guewen.baconnier@camptocamp.com>
+- Simone Orsi <simahawk@gmail.com>
 
 Other credits
-~~~~~~~~~~~~~
+-------------
 
 **Financial support**
 
-* Cosanum
-* Camptocamp R&D
-* ACSONE R&D
+- Cosanum
+- Camptocamp R&D
+- ACSONE R&D
 
 Maintainers
-~~~~~~~~~~~
+-----------
 
 This module is maintained by the OCA.
 
@@ -143,6 +147,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
 
 |maintainer-simahawk| 
 
-This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/16.0/rest_log>`_ project on GitHub.
+This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/18.0/rest_log>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
diff --git a/rest_log/exceptions.py b/rest_log/exceptions.py
@@ -5,7 +5,6 @@
 
 
 class RESTServiceDispatchException(Exception):
-
     rest_json_info = {}
 
     def __init__(self, message, log_entry_url):
diff --git a/rest_log/models/rest_log.py b/rest_log/models/rest_log.py
@@ -85,7 +85,7 @@ def _get_exception_severity_mapping(self):
                 continue
             exc_name = severity = None
             try:
-                exc_name, severity = [x.strip() for x in rule.split(":")]
+                exc_name, severity = (x.strip() for x in rule.split(":"))
                 if not exc_name or not severity:
                     raise ValueError
             except ValueError:
diff --git a/rest_log/pyproject.toml b/rest_log/pyproject.toml
@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"
diff --git a/rest_log/readme/CONFIGURE.md b/rest_log/readme/CONFIGURE.md
@@ -1,31 +1,30 @@
-Logs retention
-~~~~~~~~~~~~~~
+## Logs retention
 
-Logs are kept in database for every REST requests made by a client application.
-They can be used for debugging and monitoring of the activity.
+Logs are kept in database for every REST requests made by a client
+application. They can be used for debugging and monitoring of the
+activity.
 
-The Logs menu is shown only with Developer tools (``?debug=1``) activated.
+The Logs menu is shown only with Developer tools (`?debug=1`) activated.
 
-By default, REST logs are kept 30 days.
-You can change the duration of the retention by changing the System Parameter
-``rest.log.retention.days``.
+By default, REST logs are kept 30 days. You can change the duration of
+the retention by changing the System Parameter
+`rest.log.retention.days`.
 
 If the value is set to 0, the logs are not stored at all.
 
-Logged data is: request URL and method, parameters, headers, result or error.
+Logged data is: request URL and method, parameters, headers, result or
+error.
 
-
-Logs activation
-~~~~~~~~~~~~~~~
+## Logs activation
 
 You have 2 ways to activate logging:
 
-* on the service component set `_log_calls_in_db = True`
-* via configuration
+- on the service component set \_log_calls_in_db = True
+- via configuration
 
 In the 1st case, calls will be always be logged.
 
-In the 2nd case you can set ``rest.log.active`` param as::
+In the 2nd case you can set `rest.log.active` param as:
 
     `collection_name`  # enable for all endpoints of the collection
     `collection_name.usage`  # enable for specific endpoints
diff --git a/rest_log/readme/CONTRIBUTORS.md b/rest_log/readme/CONTRIBUTORS.md
@@ -0,0 +1,2 @@
+- Guewen Baconnier \<guewen.baconnier@camptocamp.com\>
+- Simone Orsi \<simahawk@gmail.com\>
diff --git a/rest_log/readme/CONTRIBUTORS.rst b/rest_log/readme/CONTRIBUTORS.rst
diff --git a/rest_log/readme/CREDITS.md b/rest_log/readme/CREDITS.md
@@ -0,0 +1,5 @@
+**Financial support**
+
+- Cosanum
+- Camptocamp R&D
+- ACSONE R&D
diff --git a/rest_log/readme/CREDITS.rst b/rest_log/readme/CREDITS.rst
diff --git a/rest_log/readme/DESCRIPTION.md b/rest_log/readme/DESCRIPTION.md
@@ -0,0 +1,9 @@
+When exposing REST services is often useful to see what's happening
+especially in case of errors.
+
+This module add DB logging for REST requests. It also inject in the
+response the URL of the log entry created.
+
+NOTE: this feature was implemented initially inside shopfloor app. Up to
+version 13.0.1.2.1 of this module, if shopfloor is installed, log
+records will be copied from its table.
diff --git a/rest_log/readme/DESCRIPTION.rst b/rest_log/readme/DESCRIPTION.rst
diff --git a/rest_log/readme/HISTORY.md b/rest_log/readme/HISTORY.md
@@ -1,4 +1,3 @@
-13.0.1.0.0
-~~~~~~~~~~
+## 13.0.1.0.0
 
 First official version.
diff --git a/rest_log/static/description/index.html b/rest_log/static/description/index.html
@@ -8,11 +8,10 @@
 
 /*
 :Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
+:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 
 Default cascading style sheet for the HTML output of Docutils.
-Despite the name, some widely supported CSS2 features are used.
 
 See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
@@ -275,7 +274,7 @@
   margin-left: 2em ;
   margin-right: 2em }
 
-pre.code .ln { color: gray; } /* line numbers */
+pre.code .ln { color: grey; } /* line numbers */
 pre.code, code { background-color: #eeeeee }
 pre.code .comment, code .comment { color: #5C6576 }
 pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
@@ -301,7 +300,7 @@
 span.pre {
   white-space: pre }
 
-span.problematic, pre.problematic {
+span.problematic {
   color: red }
 
 span.section-subtitle {
@@ -369,14 +368,14 @@ <h1 class="title">REST Log</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:f93e58dbd77af1254adb0cd7ace54af0b0609569883ed4a22028f11f0b663139
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<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/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/rest-framework/tree/16.0/rest_log"><img alt="OCA/rest-framework" src="https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/rest-framework-16-0/rest-framework-16-0-rest_log"><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/rest-framework&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/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/rest-framework/tree/18.0/rest_log"><img alt="OCA/rest-framework" src="https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/rest-framework-18-0/rest-framework-18-0-rest_log"><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/rest-framework&amp;target_branch=18.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>When exposing REST services is often useful to see what’s happening
 especially in case of errors.</p>
-<p>This module add DB logging for REST requests.
-It also inject in the response the URL of the log entry created.</p>
-<p>NOTE: this feature was implemented initially inside shopfloor app.
-Up to version 13.0.1.2.1 of this module,
-if shopfloor is installed, log records will be copied from its table.</p>
+<p>This module add DB logging for REST requests. It also inject in the
+response the URL of the log entry created.</p>
+<p>NOTE: this feature was implemented initially inside shopfloor app. Up to
+version 13.0.1.2.1 of this module, if shopfloor is installed, log
+records will be copied from its table.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
@@ -403,20 +402,23 @@ <h1 class="title">REST Log</h1>
 <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
 <div class="section" id="logs-retention">
 <h2><a class="toc-backref" href="#toc-entry-2">Logs retention</a></h2>
-<p>Logs are kept in database for every REST requests made by a client application.
-They can be used for debugging and monitoring of the activity.</p>
-<p>The Logs menu is shown only with Developer tools (<tt class="docutils literal"><span class="pre">?debug=1</span></tt>) activated.</p>
-<p>By default, REST logs are kept 30 days.
-You can change the duration of the retention by changing the System Parameter
+<p>Logs are kept in database for every REST requests made by a client
+application. They can be used for debugging and monitoring of the
+activity.</p>
+<p>The Logs menu is shown only with Developer tools (<tt class="docutils literal"><span class="pre">?debug=1</span></tt>)
+activated.</p>
+<p>By default, REST logs are kept 30 days. You can change the duration of
+the retention by changing the System Parameter
 <tt class="docutils literal">rest.log.retention.days</tt>.</p>
 <p>If the value is set to 0, the logs are not stored at all.</p>
-<p>Logged data is: request URL and method, parameters, headers, result or error.</p>
+<p>Logged data is: request URL and method, parameters, headers, result or
+error.</p>
 </div>
 <div class="section" id="logs-activation">
 <h2><a class="toc-backref" href="#toc-entry-3">Logs activation</a></h2>
 <p>You have 2 ways to activate logging:</p>
 <ul class="simple">
-<li>on the service component set <cite>_log_calls_in_db = True</cite></li>
+<li>on the service component set _log_calls_in_db = True</li>
 <li>via configuration</li>
 </ul>
 <p>In the 1st case, calls will be always be logged.</p>
@@ -441,7 +443,7 @@ <h1><a class="toc-backref" href="#toc-entry-6">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/rest-framework/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/rest-framework/issues/new?body=module:%20rest_log%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/rest-framework/issues/new?body=module:%20rest_log%0Aversion:%2018.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">
@@ -472,15 +474,13 @@ <h2><a class="toc-backref" href="#toc-entry-10">Other credits</a></h2>
 <div class="section" id="maintainers">
 <h2><a class="toc-backref" href="#toc-entry-11">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
-<a class="reference external image-reference" href="https://odoo-community.org">
-<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
-</a>
+<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
 <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>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
 <p><a class="reference external image-reference" href="https://github.com/simahawk"><img alt="simahawk" src="https://github.com/simahawk.png?size=40px" /></a></p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/rest-framework/tree/16.0/rest_log">OCA/rest-framework</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/rest-framework/tree/18.0/rest_log">OCA/rest-framework</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>
diff --git a/rest_log/tests/common.py b/rest_log/tests/common.py
@@ -11,7 +11,7 @@
 from odoo.addons.website.tools import MockRequest
 
 
-class TestDBLoggingMixin(object):
+class TestDBLoggingMixin:
     @staticmethod
     def _get_service(class_or_instance, collection=None):
         # pylint: disable=R7980
diff --git a/rest_log/tests/test_db_logging.py b/rest_log/tests/test_db_logging.py
@@ -40,8 +40,8 @@ def test_log_enabled_conf_parsing(self):
         expected = {
             # fmt:off
             "coll1.service1.endpoint": ("success", "failed"),
-            "coll1.service2.endpoint": ("failed", ),
-            "coll2.service1.endpoint": ("success", ),
+            "coll1.service2.endpoint": ("failed",),
+            "coll2.service1.endpoint": ("success",),
             # fmt: on
         }
         self.assertEqual(self.env["rest.log"]._get_log_active_conf(), expected)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[build-system]`
	`2`	`+requires = ["whool"]`
	`3`	`+build-backend = "whool.buildapi"`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+- Guewen Baconnier \<[email protected]\>`
	`2`	`+- Simone Orsi \<[email protected]\>`