Release/sql types (#140)

* chore: Update makefile for tests-coverage command with database support

* chore: Update pyproject.toml packages formatting

* chore: Update VSCode settings for Python linting and formatting

* feat: Add database types for various data types

* feat: Add PySQLXJsonEnconder class for JSON encoding

* chore: Refactor import statements in pysqlx_engine

* Refactor import statements in pysqlx_engine

* remove benchmark tests

* chore: Update PySQLXEngineSync test_query.py with type casting and tuple parameter

---------

Co-authored-by: carlos.rian <carlos.rian@quartile.com>

Author: carlos-rian

.vscode/settings.json

@@ -1,8 +1,18 @@
 {
-    "python.testing.pytestArgs": [
-        "tests"
-    ],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
-    "python.linting.mypyEnabled": false,
+    "files.watcherExclude": {
+        "**/__pycache__/**": true,
+    },
+    "[python]": {
+        "editor.rulers": [
+            120
+        ],
+        "editor.formatOnSave": true,
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": "explicit"
+        },
+        "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.bracketPairColorization.enabled": true
+    },
 }

makefile

@@ -25,7 +25,7 @@ upt-dev-deps:
 
 
 #--ignore=tests/benchmark 
-tests-coverage:
+tests-coverage-with-database:
 	make tests-databases && sleep 10 && \
 	poetry run pytest tests -v -x \
 		--doctest-modules \
@@ -36,6 +36,16 @@ tests-coverage:
 		--cov-report=html:tests/results/html \
 		--junitxml=tests/results/xml/test-results.xml
 
+tests-coverage:
+	poetry run pytest tests -v -x \
+		--doctest-modules \
+		--ignore=tests/benchmark \
+		--cov=pysqlx_engine \
+		--cov=tests \
+		--durations=0 \
+		--cov-report=html:tests/results/html \
+		--junitxml=tests/results/xml/test-results.xml
+
 requirements:
 	poetry export -f requirements.txt --output requirements.txt  --without-hashes
 

poetry.lock

@@ -11,9 +11,7 @@ homepage = "https://carlos-rian.github.io/pysqlx-engine"
 documentation = "https://carlos-rian.github.io/pysqlx-engine"
 keywords = ["async", "database", "sql", "engine", "fastapi"]
 
-packages = [
-    { include = "pysqlx_engine"},
-]
+packages = [{ include = "pysqlx_engine" }]
 
 classifiers = [
     "Framework :: AnyIO",
@@ -49,9 +47,7 @@ classifiers = [
 
 [tool.poetry.dependencies]
 python = "^3.7"
-pydantic = [
-    {version = ">=1 <3", python = ">=3.7"}
-]
+pydantic = [{ version = ">=1 <3", python = ">=3.7" }]
 pysqlx-core = "^0.1"
 typing-extensions = ">=4.5,<5"
 Pygments = "^2.15.1"
@@ -60,7 +56,7 @@ Pygments = "^2.15.1"
 black = "^23"
 isort = [
     { version = "^5.11", python = "<3.8" },
-    { version = "^5.12", python = ">=3.8" }
+    { version = "^5.12", python = ">=3.8" },
 ]
 pytest = ">=7.*"
 pytest-asyncio = ">=0.*"
@@ -69,6 +65,22 @@ pytest-dotenv = "^0"
 pytest-xdist = "^3"
 toml = "^0.10.2"
 httpx = "^0.24"
+ruff = "^0.3.4"
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "tab"
+docstring-code-format = true
+docstring-code-line-length = 120
+
+[tool.ruff.lint]
+ignore = ["E402", "F403", "F405"]
+
+[tool.ruff.lint.isort]
+case-sensitive = true
 
 
 [build-system]
@@ -83,10 +95,12 @@ filterwarnings = 'error'
 timeout = 30
 xfail_strict = true
 # min, max, mean, stddev, median, iqr, outliers, ops, rounds, iterations
-addopts = [
-    '--benchmark-columns', 'min,mean,stddev,outliers,rounds,iterations',
-    '--benchmark-group-by', 'group',
-    '--benchmark-warmup', 'on',
-    '--benchmark-disable',  # this is enable by `make benchmark` when you actually want to run benchmarks
-]
-
+#addopts = [
+#    '--benchmark-columns',
+#    'min,mean,stddev,outliers,rounds,iterations',
+#    '--benchmark-group-by',
+#    'group',
+#    '--benchmark-warmup',
+#    'on',
+#    '--benchmark-disable',                        # this is enable by `make benchmark` when you actually want to run benchmarks
+#]

pyproject.toml

@@ -0,0 +1,15 @@
+from abc import ABC, abstractmethod
+
+from typing_extensions import TypeVar
+
+from .const import PROVIDER
+
+T = TypeVar("T")
+
+
+class AbstractDatabaseType(ABC):
+    @abstractmethod
+    def __init__(self, value: T): ...
+
+    @abstractmethod
+    def convert(self, provider: PROVIDER, field: str = "") -> T: ...

pysqlx_engine/_core/abc.py

@@ -10,7 +10,7 @@
     ParserSQL,
 )  # import necessary using _core to not subscribe default parser
 from .const import ISOLATION_LEVEL
-from .until import check_isolation_level, check_sql_and_parameters, pysqlx_get_error
+from .util import check_isolation_level, check_sql_and_parameters, pysqlx_get_error
 
 
 class PySQLXEngine:

pysqlx_engine/_core/aconn.py

@@ -2,7 +2,7 @@
 
 from .._core.parser import MyModel  # import necessary using _core to not subscribe default parser
 from .const import ISOLATION_LEVEL
-from .until import force_sync
+from .util import force_sync
 from .aconn import PySQLXEngine as _PySQLXEngine
 
 

pysqlx_engine/_core/conn.py

@@ -0,0 +1,24 @@
+import json
+from datetime import date, datetime, time
+from decimal import Decimal
+from uuid import UUID
+
+from .abc import AbstractDatabaseType
+from .errors import ParameterInvalidJsonValueError
+
+
+class PySQLXJsonEnconder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, bytes):
+            return obj.hex()
+
+        elif isinstance(obj, (UUID, time, date, datetime, Decimal)):
+            return str(obj)
+        try:
+            return super().default(obj)
+        except TypeError as err:
+            raise ParameterInvalidJsonValueError(
+                typ_from=type(obj),
+                typ_to="json",
+                details=str(err),
+            )

pysqlx_engine/_core/json_econder.py

@@ -6,14 +6,12 @@
 from typing import Any, Callable, Dict, List, Tuple, Type, Union
 from uuid import UUID
 
+from pysqlx_engine._core.json_econder import PySQLXJsonEnconder
+
 from .const import PROVIDER
-from .errors import (
-    ParameterInvalidJsonValueError,
-    ParameterInvalidProviderError,
-    ParameterInvalidValueError,
-)
+from .errors import ParameterInvalidProviderError, ParameterInvalidValueError
 
-value_type = Union[
+SupportedValueType = Union[
     bool,
     str,
     int,
@@ -44,6 +42,12 @@ def try_str(provider: PROVIDER, value: str, _f: str = "") -> str:
     return f"'{value}'"
 
 
+@lru_cache(maxsize=None)
+def try_nstr(provider: PROVIDER, value: str, _f: str = "") -> str:
+    value = value.replace("'", "''")
+    return f"'{value}'" if provider != "sqlserver" else f"N'{value}'"
+
+
 @lru_cache(maxsize=None)
 def try_int(_p: PROVIDER, value: int, _f: str = "") -> int:
     return value
@@ -54,6 +58,11 @@ def try_json(provider: PROVIDER, value: Union[Dict[str, Any], List[Dict[str, Any
     return f"'{data}'"
 
 
+def try_njson(provider: PROVIDER, value: Union[Dict[str, Any], List[Dict[str, Any]]], _f: str = "") -> str:
+    data = json.dumps(value, ensure_ascii=False, cls=PySQLXJsonEnconder).replace("'", "''")
+    return f"'{data}'" if provider != "sqlserver" else f"N'{data}'"
+
+
 @lru_cache(maxsize=None)
 def try_uuid(_a: PROVIDER, value: UUID, _f: str = "") -> str:
     return f"'{value}'"
@@ -172,22 +181,10 @@ def try_tuple(provider: PROVIDER, values: Tuple[Any], field: str = "") -> str:
     return "'{}'"
 
 
-class PySQLXJsonEnconder(json.JSONEncoder):
-    def default(self, obj):
-        if isinstance(obj, bytes):
-            return obj.hex()
-
-        elif isinstance(obj, (UUID, time, date, datetime, Decimal)):
-            return str(obj)
-
-        try:
-            return super().default(obj)
-        except TypeError as err:
-            raise ParameterInvalidJsonValueError(
-                typ_from=type(obj),
-                typ_to="json",
-                details=str(err),
-            )
+@lru_cache(maxsize=None)
+def try_ntuple(provider: PROVIDER, values: Tuple[Any], field: str = "") -> str:
+    _v = try_tuple(provider, values, field)
+    return _v if provider != "sqlserver" else f"N{_v}"
 
 
 def get_method(typ: Type) -> Callable:
@@ -208,27 +205,3 @@ def get_method(typ: Type) -> Callable:
     }
 
     return METHODS.get(typ)
-
-
-def convert(provider: PROVIDER, value: value_type, field: str = "") -> Union[str, int, float]:
-    if value is None:
-        return "NULL"
-
-    elif isinstance(value, Enum):
-        return try_enum(provider, value, field)
-
-    elif isinstance(value, tuple) and len(value) > 0 and isinstance(value[0], Enum):
-        return try_tuple_enum(provider, value, field)
-
-    typ_ = type(value)
-    method = get_method(typ=typ_)
-    if method is None:
-        raise ParameterInvalidValueError(
-            field=field,
-            provider=provider,
-            typ_from=typ_,
-            typ_to="str|int|float|etc",
-            details="invalid type, the value is not a allowed type.",
-        )
-
-    return method(provider, value, field)

pysqlx_engine/_core/param.py

@@ -0,0 +1,34 @@
+from enum import Enum
+from typing import Union
+
+from .abc import AbstractDatabaseType
+from .const import PROVIDER
+from .errors import ParameterInvalidValueError
+from .param import SupportedValueType, get_method, try_enum, try_tuple_enum
+
+
+def convert(provider: PROVIDER, value: SupportedValueType, field: str = "") -> Union[str, int, float]:
+    if value is None:
+        return "NULL"
+
+    elif isinstance(value, AbstractDatabaseType):
+        return value.convert(provider=provider, field=field)
+
+    elif isinstance(value, Enum):
+        return try_enum(provider, value, field)
+
+    elif isinstance(value, tuple) and len(value) > 0 and isinstance(value[0], Enum):
+        return try_tuple_enum(provider, value, field)
+
+    typ_ = type(value)
+    method = get_method(typ=typ_)
+    if method is None:
+        raise ParameterInvalidValueError(
+            field=field,
+            provider=provider,
+            typ_from=typ_,
+            typ_to="str|int|float|etc",
+            details="invalid type, the value is not a allowed type.",
+        )
+
+    return method(provider, value, field)