[IMP] util/pg: add a query format utility

We want to move away of manual formatting.

Part-of: #20
Co-authored-by: Christophe Simonis <[email protected]>

Author: aj-fuentes

src/base/tests/test_util.py

@@ -924,3 +924,56 @@ def test_expand_braces(self, value, expected):
     def test_expand_braces_failure(self, value):
         with self.assertRaises(ValueError):
             util.expand_braces(value)
+
+
+class TestQueryFormat(UnitTestCase):
+    @parametrize(
+        [
+            (
+                "SELECT id FROM {table}",
+                [],
+                {"table": "res_users"},
+                'SELECT id FROM "res_users"',
+            ),
+            (
+                "SELECT id FROM {1} WHERE {0} > 2",
+                ["id", "res_users"],
+                {},
+                'SELECT id FROM "res_users" WHERE "id" > 2',
+            ),
+            (
+                "SELECT id FROM {} WHERE {{parallel_filter}}",
+                ["res_users"],
+                {},
+                'SELECT id FROM "res_users" WHERE {parallel_filter}',
+            ),
+            (
+                "SELECT {col} FROM {table}",
+                [],
+                {"table": "res_users", "col": "id"},
+                'SELECT "id" FROM "res_users"',
+            ),
+            ("{col} = 1", [], {"col": "X; fd"}, '"X; fd" = 1'),
+            (
+                "{col1} = {col2}",
+                [],
+                {"col2": "X; fd", "col1": "xxx"},
+                '"xxx" = "X; fd"',
+            ),
+            (
+                "WITH {cte} AS (SELECT 1) SELECT 2",
+                [],
+                {"cte": "some info"},
+                'WITH "some info" AS (SELECT 1) SELECT 2',
+            ),
+            (
+                "UPDATE res_users SET id = 2 WHERE {col} = %s",
+                [],
+                {"col": "Ab"},
+                'UPDATE res_users SET id = 2 WHERE "Ab" = %s',
+            ),
+        ]
+    )
+    def test_format(self, query, args, kwargs, expected):
+        cr = self.env.cr
+        self.assertEqual(util.format_query(cr, query, *args, **kwargs), expected)

src/util/pg.py

@@ -114,6 +114,20 @@ def execute(query):
             )
 
 
+def format_query(cr, query, *args, **kwargs):
+    """
+    Format the `query` replacing arguments as SQL indentifiers
+    Example:
+    ```
+    >>> util.format_query(cr, "SELECT {0} FROM {table}", "id", table="res_users")
+    SELECT "id" FROM "res_users"
+    ```
+    """
+    args = tuple(a if isinstance(a, sql.Composable) else sql.Identifier(a) for a in args)
+    kwargs = {k: v if isinstance(v, sql.Composable) else sql.Identifier(v) for k, v in kwargs.items()}
+    return sql.SQL(query).format(*args, **kwargs).as_string(cr._cnx)
+
+
 def explode_query(cr, query, alias=None, num_buckets=8, prefix=None):
     """
     Explode a query to multiple queries that can be executed in parallel