feat: add new function wrap_backticks

Author: NightMarcher

examples/service/routers/account.py

@@ -45,6 +45,7 @@ async def query_by_id_view(
     aid: int = Query(...),
 ):
     meta = AccountMgr.model._meta
+    print(AccountMgr.table, type(AccountMgr.table))
     print(dir(meta))
     print("db_complex_fields", meta.db_complex_fields, "", sep="\n")
     print("db_default_fields", meta.db_default_fields, "", sep="\n")

fastapi_esql/__init__.py

@@ -20,6 +20,7 @@
     Singleton,
     convert_dicts,
     timing,
+    wrap_backticks,
 )
 
 __version__ = "0.0.11"
@@ -39,6 +40,7 @@
     "convert_dicts",
     "escape_string",
     "timing",
+    "wrap_backticks",
 ]
 
 dictConfig({

fastapi_esql/utils/__init__.py

@@ -1,4 +1,4 @@
-from .converter import convert_dicts
+from .converter import convert_dicts, wrap_backticks
 from .cursor_handler import CursorHandler
 from .decorator import timing
 from .metaclass import Singleton

fastapi_esql/utils/converter.py

@@ -18,3 +18,8 @@ def convert_dicts(dicts, converters: Dict[str, Callable]):
                 d[field] = converter(value)
             except Exception as e:
                 logger.warning(f"Converting value `{value}` by `{converter.__name__}` failed => {e}")
+
+
+def wrap_backticks(identifier: str):
+    assert isinstance(identifier, str), f"identifier({identifier}) must be instance of `str`"
+    return f"`{str(identifier).strip('`')}`"

fastapi_esql/utils/sqlizer.py

@@ -7,6 +7,7 @@
 from tortoise.query_utils import QueryModifier
 
 from ..const.error import QsParsingError, WrongParamsError
+from .converter import wrap_backticks
 
 logger = getLogger(__name__)
 # To ensure the functionality of the RawSQL

tests/test_converter.py

@@ -2,7 +2,7 @@
 from json import loads
 from unittest import TestCase
 
-from fastapi_esql import convert_dicts, escape_string
+from fastapi_esql import convert_dicts, escape_string, wrap_backticks
 
 
 class TestConvertDicts(TestCase):
@@ -31,3 +31,16 @@ def test_normal(self):
         assert escape_string("'") == "\\'"
         assert escape_string('"') == '\\"'
         assert escape_string('\\') == '\\\\'
+
+
+class TestWrapBackticks(TestCase):
+
+    def test_wrong_input(self):
+        with self.assertRaises(AssertionError):
+            wrap_backticks(1024)
+
+    def test_without_backticks(self):
+        assert wrap_backticks("order") == "`order`"
+
+    def test_with_backticks(self):
+        assert wrap_backticks("`order`") == "`order`"