simple insert_dict() builder

Author: edvardm

pypika/queries.py

@@ -1,6 +1,6 @@
 from copy import copy
 from functools import reduce
-from typing import Any, List, Optional, Sequence, Tuple as TypedTuple, Type, Union
+from typing import Any, List, Optional, Sequence, Tuple as TypedTuple, Type, Union, Set, Dict
 
 from pypika.enums import Dialects, JoinType, ReferenceOption, SetOperation
 from pypika.terms import (
@@ -750,7 +750,7 @@ def __init__(
         self._select_star_tables = set()
         self._mysql_rollup = False
         self._select_into = False
-
+        self._using_insert_dict = False
         self._subquery_count = 0
         self._foreign_table = False
 
@@ -890,6 +890,9 @@ def columns(self, *terms: Any) -> "QueryBuilder":
         if self._insert_table is None:
             raise AttributeError("'Query' object has no attribute '%s'" % "insert")
 
+        if self._using_insert_dict:
+            raise QueryException("Cannot mix use of columns() and insert_dict()")
+
         if terms and isinstance(terms[0], (list, tuple)):
             terms = terms[0]
 
@@ -903,6 +906,15 @@ def insert(self, *terms: Any) -> "QueryBuilder":
         self._apply_terms(*terms)
         self._replace = False
 
+    def insert_dict(self, data: Dict[str, Any]) -> "QueryBuilder":
+        cols = data.keys()
+        if self._columns and self._columns != cols:
+            raise QueryException("Current columns differs from columns in keys")
+
+        builder = self.columns(*cols).insert(*data.values())
+        builder._using_insert_dict = True
+        return builder
+
     @builder
     def replace(self, *terms: Any) -> "QueryBuilder":
         self._apply_terms(*terms)

pypika/tests/test_inserts.py

@@ -17,6 +17,7 @@
 )
 from pypika.terms import Values
 from pypika.utils import QueryException
+from datetime import datetime
 
 __author__ = "Timothy Heys"
 __email__ = "[email protected]"
@@ -168,6 +169,28 @@ def test_insert_with_statement(self):
             'WITH sub_qs AS (SELECT "id" FROM "abc") INSERT INTO "abc" SELECT "sub_qs"."id" FROM sub_qs', str(q)
         )
 
+class InsertIntoWithDict(unittest.TestCase):
+    table_abc = Table("abc")
+
+    def test_inserting_simple_dictionary(self):
+        q = Query().into(self.table_abc).insert_dict({"c1": "value", "c2": 1})
+        self.assertEqual("INSERT INTO \"abc\" (\"c1\",\"c2\") VALUES ('value',1)", str(q))
+
+    def test_inserting_dictionary_goes_through_value_quoting_logic(self):
+        q = Query().into(self.table_abc).insert_dict({"num": 1, "timestamp": datetime(2023, 4, 18)})
+        self.assertEqual("INSERT INTO \"abc\" (\"num\",\"timestamp\") VALUES (1,'2023-04-18T00:00:00')", str(q))
+
+    def test_inserting_dictionary_produces_builder(self):
+        q = Query().into(self.table_abc).insert_dict({"num": 1, "timestamp": datetime(2023, 4, 18)})
+        q = q.insert(2, datetime(2023, 4, 19))
+        self.assertEqual("INSERT INTO \"abc\" (\"num\",\"timestamp\") VALUES (1,'2023-04-18T00:00:00'),(2,'2023-04-19T00:00:00')", str(q))
+
+    def test_columns_is_not_allowed_with_insert_dict(self):
+        with self.assertRaises(QueryException):
+            Query().into(self.table_abc).columns("a", "b").insert_dict({"num": 1})
+
+        with self.assertRaises(QueryException):
+            Query().into(self.table_abc).insert_dict({"num": 1}).columns("a", "b")
 
 class PostgresInsertIntoOnConflictTests(unittest.TestCase):
     table_abc = Table("abc")

pypika/utils.py

@@ -36,10 +36,18 @@ class FunctionException(Exception):
     pass
 
 
+<<<<<<< HEAD
 C = TypeVar("C")
 
 
 def builder(func: C) -> C:
+=======
+class MixedInsertStyleError(QueryException):
+    pass
+
+
+def builder(func: Callable) -> Callable:
+>>>>>>> 25aabb6 (simple insert_dict() builder)
     """
     Decorator for wrapper "builder" functions.  These are functions on the Query class or other classes used for
     building queries which mutate the query and return self.  To make the build functions immutable, this decorator is