[chore] format code using ruff instead of black

KangOl · KangOl · commit 2bd20f0895cb · 2024-01-10T20:51:12.000Z
closes #32 Signed-off-by: Christophe Simonis (chs) <chs@odoo.com>
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,11 +17,8 @@ repos:
     - id: ruff
       name: Check code with Ruff, apply automatic fixes
       args: [ --fix, --show-fixes, --show-source, --exit-non-zero-on-fix ]
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 23.12.1
-    hooks:
-      - id: black
-        name: Format code with Black automatically
+    - id: ruff-format
+      name: Format code with Ruff
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:
diff --git a/pyproject.toml b/pyproject.toml
@@ -23,16 +23,13 @@ raw-options.version_scheme = "calver-by-date"
 [tool.hatch.build.hooks.vcs]
 version-file = "src/_version.py"
 
-[tool.black]
-line-length = 120
-
 [tool.ruff]
 fix = true
 show-fixes = true
 ignore = [
     "B904",  # raise-without-from-inside-except; not python2 compatible
     "B905",  # zip-without-explicit-strict; not python2 compatible
-    "E501",  # line-too-long; handled by `black` formatting
+    "E501",  # line-too-long; handled by auto-formatting
     "E731",  # lambda-assignment
     "PERF203",  # try-except-in-loop
     "PLR09",  # too-many-*; unwanted code complexity checks
@@ -42,6 +39,8 @@ ignore = [
     "TRY003",  # raise-vanilla-args; we can live without it
     "TRY200",  # reraise-no-cause; not python2 compatible
     "RET505",  # only true for simple if/elif branches (like in the ruff doc example). if/elif blocks are easier to read in most cases
+
+    "ISC001",  # avoid incompatibility with the ruff formatter
     # not (yet) supported rules
     # "E301",
     # "E302",
diff --git a/src/base/0.0.0/post-commercial_partner_id.py b/src/base/0.0.0/post-commercial_partner_id.py
@@ -7,4 +7,4 @@ def migrate(cr, version):
     # Fight the Murphy's Law, and recompute the value on partners with a NULL value.
     cr.execute("SELECT id FROM res_partner WHERE commercial_partner_id IS NULL")
     if cr.rowcount:
-        util.recompute_fields(cr, "res.partner", ["commercial_partner_id"], ids=[id_ for id_, in cr.fetchall()])
+        util.recompute_fields(cr, "res.partner", ["commercial_partner_id"], ids=[id_ for (id_,) in cr.fetchall()])
diff --git a/src/base/0.0.0/pre-models-ir_model_relation.py b/src/base/0.0.0/pre-models-ir_model_relation.py
@@ -43,6 +43,6 @@ def _register_hook(self):
                  WHERE table_name IN %s
             """
             self.env.cr.execute(query, [tuple(gone_m2m)])
-            back_m2m = "\n".join(" - %s via %s" % (tn, gone_m2m[tn]) for tn, in self.env.cr.fetchall())
+            back_m2m = "\n".join(" - %s via %s" % (tn, gone_m2m[tn]) for (tn,) in self.env.cr.fetchall())
             if back_m2m:
                 raise util.MigrationError("The following m2m relations have respawn:\n%s" % back_m2m)
diff --git a/src/base/tests/test_ensure_has_pk.py b/src/base/tests/test_ensure_has_pk.py
@@ -27,7 +27,7 @@ def invariant(self):
 
         cr.execute(query)
         if cr.rowcount:
-            tables = "\n".join(" - %s" % t for t, in cr.fetchall())
+            tables = "\n".join(" - %s" % t for (t,) in cr.fetchall())
             msg = "Some tables doesn't have any primary key:\n{}".format(tables)
             _logger.critical(msg)
             if util.on_CI():
diff --git a/src/base/tests/test_util.py b/src/base/tests/test_util.py
@@ -340,7 +340,7 @@ class TestIterBrowse(UnitTestCase):
     def test_iter_browse_iter(self):
         cr = self.env.cr
         cr.execute("SELECT id FROM res_country")
-        ids = [c for c, in cr.fetchall()]
+        ids = [c for (c,) in cr.fetchall()]
         chunk_size = 10
 
         Country = type(self.env["res.country"])
@@ -354,7 +354,7 @@ def test_iter_browse_iter(self):
     def test_iter_browse_call(self):
         cr = self.env.cr
         cr.execute("SELECT id FROM res_country")
-        ids = [c for c, in cr.fetchall()]
+        ids = [c for (c,) in cr.fetchall()]
         chunk_size = 10
 
         Country = type(self.env["res.country"])
@@ -383,7 +383,7 @@ def test_iter_browse_create(self, multi):
     def test_iter_browse_iter_twice(self):
         cr = self.env.cr
         cr.execute("SELECT id FROM res_country")
-        ids = [c for c, in cr.fetchall()]
+        ids = [c for (c,) in cr.fetchall()]
         chunk_size = 10
 
         ib = util.iter_browse(self.env["res.country"], ids, logger=None, chunk_size=chunk_size)
@@ -397,7 +397,7 @@ def test_iter_browse_iter_twice(self):
     def test_iter_browse_call_twice(self):
         cr = self.env.cr
         cr.execute("SELECT id FROM res_country")
-        ids = [c for c, in cr.fetchall()]
+        ids = [c for (c,) in cr.fetchall()]
         chunk_size = 10
 
         ib = util.iter_browse(self.env["res.country"], ids, logger=None, chunk_size=chunk_size)
diff --git a/src/testing.py b/src/testing.py
@@ -106,9 +106,7 @@ def _set_value(self, key, value):
         query = """
             INSERT INTO {} (key, value) VALUES (%s, %s)
             ON CONFLICT (key) DO UPDATE SET value=EXCLUDED.value
-        """.format(
-            DATA_TABLE
-        )
+        """.format(DATA_TABLE)
         self._data_table_cr.execute(query, (key, value))
         self._data_table_cr._cnx.commit()
 
@@ -135,9 +133,7 @@ def _init_db(self):
                 query = """ CREATE TABLE {} (
                     key VARCHAR(255) PRIMARY KEY,
                     value JSONB NOT NULL
-                )""".format(
-                    DATA_TABLE
-                )
+                )""".format(DATA_TABLE)
                 self._data_table_cr.execute(query)
                 self._data_table_cr._cnx.commit()
             UpgradeCommon.__initialized = True
diff --git a/src/util/accounting.py b/src/util/accounting.py
@@ -21,7 +21,7 @@ def no_deprecated_accounts(cr):
      RETURNING id
         """
     )
-    ids = tuple(r for r, in cr.fetchall())
+    ids = tuple(r for (r,) in cr.fetchall())
     yield
     if ids:
         cr.execute(
@@ -48,9 +48,7 @@ def no_fiscal_lock(cr):
               FROM res_company old
              WHERE old.id = c.id
          RETURNING {}, old.id
-        """.format(
-            set_val, returns
-        )
+        """.format(set_val, returns)
     )
     data = cr.fetchall()
     yield
@@ -60,9 +58,7 @@ def no_fiscal_lock(cr):
             UPDATE res_company
                SET {}
              WHERE id = %s
-        """.format(
-            set_val
-        ),
+        """.format(set_val),
         data,
     )
 
diff --git a/src/util/data.py b/src/util/data.py
@@ -46,9 +46,9 @@ def uniq_tags(cr, model, uniq_column="name", order="id"):
                     [f_model, fc],
                 )
                 [is_many2one] = cr.fetchone()
-        assert (
-            is_many2many or is_many2one
-        ), "Can't determine if column `%s` of table `%s` is a many2one or many2many" % (fc, ft)
+        assert is_many2many or is_many2one, (
+            "Can't determine if column `%s` of table `%s` is a many2one or many2many" % (fc, ft)
+        )
         if is_many2many:
             upds.append(
                 """
@@ -60,9 +60,7 @@ def uniq_tags(cr, model, uniq_column="name", order="id"):
                      SELECT r.{c1}, r.{c2}
                        FROM {rel} r
                        JOIN dups d ON (r.{c2} = d.id)
-            """.format(
-                    rel=ft, c1=cols[0], c2=fc
-                )
+            """.format(rel=ft, c1=cols[0], c2=fc)
             )
         else:
             upds.append(
@@ -71,9 +69,7 @@ def uniq_tags(cr, model, uniq_column="name", order="id"):
                        SET {c} = d.id
                       FROM dups d
                      WHERE r.{c} = ANY(d.others)
-                """.format(
-                    rel=ft, c=fc
-                )
+                """.format(rel=ft, c=fc)
             )
 
     assert upds  # if not m2m found, there is something wrong...
@@ -96,9 +92,7 @@ def uniq_tags(cr, model, uniq_column="name", order="id"):
         ),
         {updates}
         DELETE FROM {table} WHERE id IN (SELECT unnest(others) FROM dups)
-    """.format(
-        **locals()
-    )
+    """.format(**locals())
 
     cr.execute(query, [model])
 
diff --git a/src/util/domains.py b/src/util/domains.py
@@ -293,9 +293,7 @@ def adapt_domains(cr, model, old, new, adapter=None, skip_inherit=(), force_adap
             SELECT id, {df.model_select}, {df.domain_column}
               FROM {df.table} t
              WHERE {df.domain_column} ~ %s
-        """.format(
-                df=df
-            ),
+        """.format(df=df),
             [match_old],
         )
         for id_, model, domain in cr.fetchall():
diff --git a/src/util/fields.py b/src/util/fields.py
@@ -82,9 +82,7 @@ def ensure_m2o_func_field_data(cr, src_table, column, dst_table):
             SELECT count(1)
               FROM "{src_table}"
              WHERE "{column}" NOT IN (SELECT id FROM "{dst_table}")
-        """.format(
-            src_table=src_table, column=column, dst_table=dst_table
-        )
+        """.format(src_table=src_table, column=column, dst_table=dst_table)
     )
     if cr.fetchone()[0]:
         remove_column(cr, src_table, column, cascade=True)
@@ -503,9 +501,7 @@ def convert_field_to_html(cr, model, field, skip_inherit=()):
                SET "{1}" = h.value
               FROM html_values AS h
              WHERE "{0}".id = h.id
-        """.format(
-            table, field, pg_text2html("t.value")
-        )
+        """.format(table, field, pg_text2html("t.value"))
     else:
         query = 'UPDATE "{0}" SET "{1}" = {2} WHERE "{1}" IS NOT NULL'.format(table, field, pg_text2html(field))
     parallel_execute(cr, explode_query_range(cr, query, table=table))
@@ -520,9 +516,7 @@ def convert_field_to_html(cr, model, field, skip_inherit=()):
                SET src = {}, value = {}, type = %s
              WHERE type = 'model'
                AND name = %s
-            """.format(
-                pg_text2html("src", wrap=wrap), pg_text2html("value", wrap=wrap)
-            ),
+            """.format(pg_text2html("src", wrap=wrap), pg_text2html("value", wrap=wrap)),
             [ttype, "%s,%s" % (model, field)],
         )
     cr.execute(
@@ -614,9 +608,7 @@ def convert_field_to_property(
                AND name='{field}'
                AND type='{type}'
                AND fields_id={fields_id}
-            """.format(
-                **locals()
-            ),
+            """.format(**locals()),
         )
 
     cr.execute(
@@ -635,9 +627,7 @@ def convert_field_to_property(
                                WHERE fields_id=%(fields_id)s
                                  AND company_id IS NOT DISTINCT FROM cte.company
                                  AND res_id=cte.res_id)
-    """.format(
-            **locals()
-        ),
+    """.format(**locals()),
         locals(),
     )
     # default property
@@ -647,9 +637,7 @@ def convert_field_to_property(
                 INSERT INTO ir_property(name, type, fields_id, {value_field})
                      VALUES (%s, %s, %s, %s)
                   RETURNING id
-            """.format(
-                value_field=value_field
-            ),
+            """.format(value_field=value_field),
             (field, type, fields_id, default_value),
         )
         [prop_id] = cr.fetchone()
@@ -885,9 +873,7 @@ def _update_field_usage_multi(cr, models, old, new, domain_adapter=None, skip_in
   </summary>
   <ul>{li}</ul>
 </details>
-            """.format(
-                **locals()
-            ),
+            """.format(**locals()),
             category="Fields renamed",
             format="html",
         )
diff --git a/src/util/helpers.py b/src/util/helpers.py
@@ -67,9 +67,7 @@ def table_of_model(cr, model):
         {gte_saas13_lte_saas14_3} mail.notification mail_message_res_partner_needaction_rel
 
         project.task.stage.personal project_task_user_rel
-    """.format(
-                gte_saas13_lte_saas14_3="" if version_gte("9.saas~13") and not version_gte("saas~14.3") else "#"
-            )
+    """.format(gte_saas13_lte_saas14_3="" if version_gte("9.saas~13") and not version_gte("saas~14.3") else "#")
         )
     )
     return exceptions.get(model, model.replace(".", "_"))
@@ -122,7 +120,7 @@ def model_of_table(cr, table):
             """,
             [table],
         )
-        candidates = [m for m, in cr.fetchall()]
+        candidates = [m for (m,) in cr.fetchall()]
         if candidates:
             if len(candidates) > 1:
                 _logger.critical("cannot determine model of table %r. Multiple candidates: %r", table, candidates)
diff --git a/src/util/inconsistencies.py b/src/util/inconsistencies.py
@@ -59,9 +59,7 @@ def verify_companies(
                AND b.{comodel_company_field} IS NOT NULL
                AND a.{model_company_field} != b.{comodel_company_field}
              LIMIT {limit}
-        """.format(
-            **locals()
-        )
+        """.format(**locals())
     else:  # many2many
         m2m_relation = field_values["relation_table"]
         f1, f2 = field_values["column1"], field_values["column2"]
@@ -74,9 +72,7 @@ def verify_companies(
                AND b.{comodel_company_field} IS NOT NULL
                AND a.{model_company_field} != b.{comodel_company_field}
              LIMIT {limit}
-        """.format(
-            **locals()
-        )
+        """.format(**locals())
 
     cr.execute(query)
     if cr.rowcount:
@@ -105,9 +101,7 @@ def verify_companies(
                 {lis}
               </ul>
             </details>
-        """.format(
-                **locals()
-            ),
+        """.format(**locals()),
             category="Multi-company inconsistencies",
             format="html",
         )
@@ -339,9 +333,7 @@ def verify_products(
     is different from that defined on the {title}. To allow the upgrade to continue, the product
     on the {foreign_title} and on the {title} must be the same.
     These {foreign_title} have inconsistencies:
-    """.format(
-        **locals()
-    )
+    """.format(**locals())
     msg += "\n".join(
         "     * {}(id={}) has Product `{}`(id={}), {}(id={}) has Product `{}`(id={})".format(
             foreign_title, fline_id, fline_product, fline_product_id, title, line_id, line_product, line_product_id
diff --git a/src/util/models.py b/src/util/models.py
diff --git a/src/util/modules.py b/src/util/modules.py
diff --git a/src/util/orm.py b/src/util/orm.py
diff --git a/src/util/pg.py b/src/util/pg.py
diff --git a/src/util/records.py b/src/util/records.py
diff --git a/tools/generate-inherit.py b/tools/generate-inherit.py
