drop supporting sqlalchemy object (#70)

* drop supporting sqlalchemy object

* fix format

* update isort

* fix isort option

* remove unused test

* remove comment

* update documents

Author: koxudaxi

README.md

@@ -7,11 +7,10 @@
 ![license](https://img.shields.io/github/license/koxudaxi/py-data-api.svg)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
-py-data-api is a user-friendly client which supports SQLAlchemy models.
-Also, the package includes DB API 2.0 Client and SQLAlchemy Dialects.
+py-data-api is a client for Data API of [Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html).
+Also, the package includes SQLAlchemy Dialects and DB API 2.0 Client.
 
 ## Features
-- A user-friendly client which supports SQLAlchemy models
 - SQLAlchemy Dialects
 - DB API 2.0 compatible client [PEP 249](https://www.python.org/dev/peps/pep-0249/)
 
@@ -38,10 +37,8 @@ from typing import List
 
 from sqlalchemy import Column, Integer, String
 from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.orm import Query
-from sqlalchemy.sql import Insert
 
-from pydataapi import DataAPI, transaction, Result, Record
+from pydataapi import DataAPI, Result
 
 
 class Pets(declarative_base()):
@@ -54,115 +51,6 @@ database: str = 'test'
 resource_arn: str = 'arn:aws:rds:us-east-1:123456789012:cluster:serverless-test-1'
 secret_arn: str = 'arn:aws:secretsmanager:us-east-1:123456789012:secret:serverless-test1'
 
-
-def example_with_statement():
-    # DataAPI supports with statement for handling transaction
-    with DataAPI(database=database, resource_arn=resource_arn, secret_arn=secret_arn) as data_api:
-
-        # start transaction
-
-        insert: Insert = Insert(Pets, {'name': 'dog'})
-        # INSERT INTO pets (name) VALUES ('dog')
-
-        # `execute` accepts SQL statement as str or SQL Alchemy SQL objects
-        result: Result = data_api.execute(insert)
-        print(result.number_of_records_updated)
-        # 1
-
-        query = Query(Pets).filter(Pets.id == 1)
-        result: Result = data_api.execute(query)  # or data_api.execute('select id, name from pets')
-        # SELECT pets.id, pets.name FROM pets WHERE pets.id = 1
-
-        # `Result` like a Result object in SQL Alchemy
-        print(result.scalar())
-        # 1
-
-        print(result.one())
-        # [Record<id=1, name='dog'>]
-  
-        # `Result` is Sequence[Record]
-        records: List[Record] = list(result)
-        print(records)
-        # [Record<id=1, name='dog'>]
-
-        # Record is Sequence and Iterator
-        record = records[0]
-        print(record[0])
-        # 1
-        print(record[1])
-        # dog
-
-        for column in record:
-            print(column)
-            # 1 ...
-
-        # show record as dict()
-        print(record.dict())
-        # {'id': 1, 'name': 'dog'}
-
-        # batch insert
-        insert: Insert = Insert(Pets)
-        data_api.batch_execute(insert, [
-            {'id': 2, 'name': 'cat'},
-            {'id': 3, 'name': 'snake'},
-            {'id': 4, 'name': 'rabbit'},
-        ])
-
-        result = data_api.execute('select * from pets')
-        print(list(result))
-        # [Record<id=1, name='dog'>, Record<id=2, name='cat'>, Record<id=3, name='snake'>, Record<id=4, name='rabbit'>]
-
-        # result is a sequence object
-        for record in result:
-            print(record)
-            # Record<id=1, name='dog'> ...
-
-        # commit
-
-
-def example_decorator():
-    pet_names: List[str] = ['dog', 'cat', 'snake']
-    add_pets(pet_names)
-
-
-@transaction(database=database, resource_arn=resource_arn, secret_arn=secret_arn)
-def add_pets(data_api: DataAPI, pet_names: List[str]) -> None:
-    # start transaction
-    for pet_name in pet_names:
-        data_api.execute(Insert(Pets, {'name': pet_name}))
-        # some logic ...
-
-    # commit
-
-
-def example_simple_execute():
-    data_api = DataAPI(resource_arn=resource_arn, secret_arn=secret_arn, database=database)
-    result: Result = data_api.execute('show tables')
-    print(result.scalar())
-    # Pets
-
-
-def example_rollback():
-    with DataAPI(resource_arn=resource_arn, secret_arn=secret_arn) as data_api:
-        data_api.execute(Insert(Pets, {'name': 'dog'}))
-        # you can rollback by Exception
-        raise Exception
-
-
-def example_rollback_with_custom_exception():
-    class OriginalError(Exception):
-        pass
-
-    with DataAPI(resource_arn=resource_arn, secret_arn=secret_arn, rollback_exception=OriginalError) as data_api:
-
-        data_api.execute(Insert(Pets, {'name': 'dog'}))
-        # some logic ...
-
-        # rollback when happen `rollback_exception`
-        raise OriginalError  # rollback
-
-        # raise Exception <- DataAPI don't rollback
-
 def example_driver_for_sqlalchemy():
     from sqlalchemy.engine import create_engine
     engine = create_engine(
@@ -173,9 +61,14 @@ def example_driver_for_sqlalchemy():
             'database': 'test'}
     )
 
-    result: ResultProxy = engine.execute("select * from pets")
+    result = engine.execute("select * from pets")
     print(result.fetchall())
 
+def example_simple_execute():
+    data_api = DataAPI(resource_arn=resource_arn, secret_arn=secret_arn, database=database)
+    result: Result = data_api.execute('show tables')
+    print(result.scalar())
+    # Pets
 ```
 
 ## Contributing to pydataapi

example.py

@@ -3,8 +3,6 @@
 from sqlalchemy import Column, Integer, String
 from sqlalchemy.engine import ResultProxy
 from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.orm import Query
-from sqlalchemy.sql import Insert
 
 from pydataapi import DataAPI, Record, Result, transaction
 

pydataapi/pydataapi.py

@@ -1,11 +1,9 @@
-from contextlib import AbstractContextManager
 from datetime import date, datetime, time
 from decimal import Decimal
 from functools import wraps
 from typing import (
     Any,
     Callable,
-    ContextManager,
     Dict,
     Iterator,
     List,
@@ -23,8 +21,6 @@
 from sqlalchemy import Column
 from sqlalchemy.dialects import mysql
 from sqlalchemy.engine import Dialect, default
-from sqlalchemy.orm.query import Query
-from sqlalchemy.sql import Delete, Insert, Select, Update
 
 from pydataapi.exceptions import DataAPIError, MultipleResultsFound, NoResultFound
 
@@ -57,69 +53,6 @@
 DATE_TYPE_HINT: str = "DATE"
 
 
-def generate_sql(query: Union[Query, Insert, Update, Delete, Select]) -> str:
-    if hasattr(query, "statement"):
-        sql: str = query.statement.compile(**QUERY_STATEMENT_COMPILE_PARAMS)
-    else:
-        sql = query.compile(**QUERY_STATEMENT_COMPILE_PARAMS)
-    return str(sql)
-
-
-def wrap_process_result_value_function(
-    process_result_value: Callable[..., Any], dialect: default.DefaultDialect
-) -> Callable[..., Any]:
-    @wraps(process_result_value)
-    def wrapped(value: Any) -> Callable[..., Any]:
-        return process_result_value(value, dialect)
-
-    return wrapped
-
-
-def get_process_result_value_function(
-    table_name: str,
-    column_name: str,
-    query: Union[Select, Query],
-    dialect: default.DefaultDialect,
-) -> Callable[..., Any]:
-    process_result_value: Optional[Callable[..., Any]] = None
-    if isinstance(query, Select):  # pragma: no cover
-        for column in query.columns:
-            if column.name == column_name:
-                process_result_value = getattr(
-                    column.type, "process_result_value", None
-                )
-                break
-    elif isinstance(query, Query):  # pragma: no cover
-        for column_description in query.column_descriptions:
-            type_ = column_description["type"]
-            if type_.__tablename__ == table_name:
-                column = getattr(type_, column_name, None)
-                if column:
-                    expression = getattr(column, "expression", None)
-                    if (
-                        isinstance(expression, Column)
-                        and expression.name == column_name
-                    ):
-                        process_result_value = getattr(
-                            expression.type, "process_result_value", None
-                        )
-                break
-    if process_result_value:
-        return wrap_process_result_value_function(process_result_value, dialect)
-    return lambda v: v
-
-
-def create_process_result_value_function_list(
-    column_metadata: List[Dict[str, Any]],
-    query: Union[Select, Query],
-    dialect: default.DefaultDialect,
-) -> List[Callable[..., Any]]:
-    return [
-        get_process_result_value_function(cm["tableName"], cm["name"], query, dialect)
-        for cm in column_metadata
-    ]
-
-
 def convert_array_value(value: Union[List[Any], Tuple[Any, ...]]) -> Dict[str, Any]:
     first_value: Any = value[0]
     if isinstance(first_value, (list, tuple)):
@@ -312,27 +245,12 @@ def __getitem__(self, i: Union[int, slice]) -> Union["Record", List["Record"]]:
     def __len__(self) -> int:
         return len(self._rows)
 
-    def __init__(
-        self,
-        response: Dict[Any, Any],
-        process_result_value_function_list: Optional[List[Callable[..., Any]]] = None,
-    ) -> None:
+    def __init__(self, response: Dict[Any, Any],) -> None:
         self._response = response
-        if process_result_value_function_list:
-            self._rows: Sequence[List[Any]] = [
-                [
-                    process_result_value(_get_value_from_row(column))
-                    for column, process_result_value in zip(
-                        row, process_result_value_function_list
-                    )
-                ]
-                for row in response.get("records", [])
-            ]
-        else:
-            self._rows = [
-                [_get_value_from_row(column) for column in row]
-                for row in response.get("records", [])
-            ]
+        self._rows = [
+            [_get_value_from_row(column) for column in row]
+            for row in response.get("records", [])
+        ]
         self._column_metadata: List[Dict[str, Any]] = response.get("columnMetadata", [])
         self._headers: Optional[List[str]] = None
         self._index: int = -1
@@ -418,12 +336,6 @@ def convert_parameter_sets(cls, v: Any) -> Any:
             return [create_sql_parameters(parameter) for parameter in v]
         return v  # pragma: no cover
 
-    @validator("sql", pre=True)
-    def validate_sql(cls, v: Any) -> Any:
-        if isinstance(v, str):
-            return v
-        return generate_sql(v)
-
     def build(self) -> Dict[str, Any]:
         return self.dict(exclude_unset=True, by_alias=True)
 
@@ -547,7 +459,7 @@ def rollback(self, transaction_id: Optional[str] = None) -> str:
 
     def execute(
         self,
-        query: Union[Query, Insert, Update, Delete, Select, str],
+        query: str,
         parameters: Optional[Dict[str, Any]] = None,
         transaction_id: Optional[str] = None,
         continue_after_timeout: bool = True,
@@ -568,18 +480,11 @@ def execute(
             includeResultMetadata=True, **options.build()
         )
 
-        if isinstance(query, (Query, Select)):
-            process_result_value_function_list = create_process_result_value_function_list(
-                response.get("columnMetadata", []),
-                query,
-                QUERY_STATEMENT_COMPILE_PARAMS["dialect"],
-            )
-            return Result(response, process_result_value_function_list)
         return Result(response)
 
     def batch_execute(
         self,
-        query: Union[Query, Insert, Update, Delete, Select, str],
+        query: str,
         parameter_sets: Optional[List[Dict[str, Any]]],
         transaction_id: Optional[str] = None,
         database: Optional[str] = None,

scripts/format.sh

@@ -2,4 +2,4 @@
 set -e
 
 black pydataapi tests
-isort --recursive pydataapi tests
+isort pydataapi tests

scripts/lint.sh

@@ -2,5 +2,5 @@
 set -e
 
 black pydataapi tests --check
-isort --recursive --check-only pydataapi tests
+isort --check-only pydataapi tests
 mypy pydataapi

setup.cfg

@@ -39,7 +39,7 @@ tests_require =
     pytest-docker-compose
     mypy
     black
-    isort
+    isort>=5.0.7
     PyMySQL
     docker-compose
     requests == 2.20.1