Add example using new Synchronous API.

Author: andrew-chang-dewitt

example_sync/example/example.py

@@ -6,12 +6,13 @@
 from uuid import uuid4, UUID
 from typing import Any, List
 
-from db_wrapper import ConnectionParameters, SyncClient, Model
+from db_wrapper import SyncClient, ConnectionParameters
+from db_wrapper.model import SyncModel as Model
 
 from models import (
     AModel,
-    # ExtendedModel,
-    # ExtendedModelData,
+    ExtendedModel,
+    ExtendedModelData,
 )
 
 logging.basicConfig(level=logging.INFO)
@@ -39,7 +40,7 @@ def default(self, obj: Any) -> Any:
 client = SyncClient(conn_params)
 
 a_model = Model[AModel](client, 'a_model')
-# extended_model = ExtendedModel(client)
+extended_model = ExtendedModel(client)
 
 
 def create_a_model_record() -> UUID:
@@ -67,50 +68,49 @@ def read_a_model(id_value: UUID) -> AModel:
     return a_model.read.one_by_id(str(id_value))
 
 
-# def create_extended_models() -> None:
-#     """Show how using an extended Model can be the same as the defaults."""
-#     dicts = [{
-#         'id': uuid4(),
-#         'string': 'something',
-#         'integer': 1,
-#         'data': {'a': 1, 'b': 2, 'c': True}
-#     }, {
-#         'id': uuid4(),
-#         'string': 'something',
-#         'integer': 1,
-#         'data': {'a': 1, 'b': 2, 'c': True}
-#     }, {
-#         'id': uuid4(),
-#         'string': 'something',
-#         'integer': 1,
-#         'data': {'a': 1, 'b': 2, 'c': True}
-#     }, {
-#         'id': uuid4(),
-#         'string': 'something',
-#         'integer': 1,
-#         'data': {'a': 1, 'b': 2, 'c': True}
-#     }]
-# 
-#     new_records: List[ExtendedModelData] = [
-#         ExtendedModelData(**record) for record in dicts]
-# 
-#     # by looping over a list of records, you can use the default create.one
-#     # method to create each record as a separate transaction
-#     for record in new_records:
-#         extended_model.create.one(record)
-# 
-# 
-# def read_extended_models() -> List[ExtendedModelData]:
-#     """Show how to use an extended Model's new methods."""
-#     # We defined read.all in ./models/extended_model.py's ExtendedRead class,
-#     # then replaced ExtendedModel's read property with ExtendedRead.
-#     # As a result, we can call it just like any other method on Model.read.
-#     return extended_model.read.all()
+def create_extended_models() -> None:
+    """Show how using an extended Model can be the same as the defaults."""
+    dicts = [{
+        'id': uuid4(),
+        'string': 'something',
+        'integer': 1,
+        'data': {'a': 1, 'b': 2, 'c': True}
+    }, {
+        'id': uuid4(),
+        'string': 'something',
+        'integer': 1,
+        'data': {'a': 1, 'b': 2, 'c': True}
+    }, {
+        'id': uuid4(),
+        'string': 'something',
+        'integer': 1,
+        'data': {'a': 1, 'b': 2, 'c': True}
+    }, {
+        'id': uuid4(),
+        'string': 'something',
+        'integer': 1,
+        'data': {'a': 1, 'b': 2, 'c': True}
+    }]
+
+    new_records: List[ExtendedModelData] = [
+        ExtendedModelData(**record) for record in dicts]
+
+    # by looping over a list of records, you can use the default create.one
+    # method to create each record as a separate transaction
+    for record in new_records:
+        extended_model.create.one(record)
+
+
+def read_extended_models() -> List[ExtendedModelData]:
+    """Show how to use an extended Model's new methods."""
+    # We defined read.all in ./models/extended_model.py's ExtendedRead class,
+    # then replaced ExtendedModel's read property with ExtendedRead.
+    # As a result, we can call it just like any other method on Model.read.
+    return extended_model.read.all()
 
 
 def run() -> None:
     """Show how to make a connection, execute queries, & disconnect."""
-
     # First, have the client make a connection to the database
     client.connect()
 
@@ -121,8 +121,8 @@ def run() -> None:
     try:
         new_id = create_a_model_record()
         created_a_model = read_a_model(new_id)
-        # create_extended_models()
-        # extended_models = read_extended_models()
+        create_extended_models()
+        extended_models = read_extended_models()
     finally:
         client.disconnect()
 

example_sync/example/models/a_model.py

@@ -8,10 +8,6 @@
 class AModel(ModelData):
     """An example Item."""
 
-    # PENDS python 3.9 support in pylint,
-    # ModelData inherits from TypedDict
-    # pylint: disable=too-few-public-methods
-
     string: str
     integer: int
     array: List[str]

example_sync/example/models/extended_model.py

@@ -1,4 +1,4 @@
-"""An example implementation of custom object Model."""
+"""An example implementation of custom object SyncModel."""
 
 import json
 from typing import Any, List, Dict
@@ -7,7 +7,8 @@
 from psycopg2.extensions import register_adapter
 from psycopg2.extras import Json
 
-from db_wrapper.model import ModelData, Model, Read, Create, Client
+from db_wrapper import SyncClient
+from db_wrapper.model import ModelData, SyncModel, SyncRead, SyncCreate
 
 # tell psycopg2 to adapt all dictionaries to json instead of
 # the default hstore
@@ -17,22 +18,18 @@
 class ExtendedModelData(ModelData):
     """An example Item."""
 
-    # PENDS python 3.9 support in pylint,
-    # ModelData inherits from TypedDict
-    # pylint: disable=too-few-public-methods
-
     string: str
     integer: int
     data: Dict[str, Any]
 
 
-class ExtendedCreator(Create[ExtendedModelData]):
-    """Add custom json loading to Model.create."""
+class ExtendedCreator(SyncCreate[ExtendedModelData]):
+    """Add custom json loading to SyncModel.create."""
 
     # pylint: disable=too-few-public-methods
 
-    async def one(self, item: ExtendedModelData) -> ExtendedModelData:
-        """Override default Model.create.one method."""
+    def one(self, item: ExtendedModelData) -> ExtendedModelData:
+        """Override default SyncModel.create.one method."""
         columns: List[sql.Identifier] = []
         values: List[sql.Literal] = []
 
@@ -55,15 +52,15 @@ async def one(self, item: ExtendedModelData) -> ExtendedModelData:
         )
 
         result: List[ExtendedModelData] = \
-            await self._client.execute_and_return(query)
+            self._client.execute_and_return(query)
 
         return result[0]
 
 
-class ExtendedReader(Read[ExtendedModelData]):
+class ExtendedReader(SyncRead[ExtendedModelData]):
     """Add custom method to Model.read."""
 
-    async def all_by_string(self, string: str) -> List[ExtendedModelData]:
+    def all_by_string(self, string: str) -> List[ExtendedModelData]:
         """Read all rows with matching `string` value."""
         query = sql.SQL(
             'SELECT * '
@@ -74,29 +71,29 @@ async def all_by_string(self, string: str) -> List[ExtendedModelData]:
             string=sql.Identifier(string)
         )
 
-        result: List[ExtendedModelData] = await self \
+        result: List[ExtendedModelData] = self \
             ._client.execute_and_return(query)
 
         return result
 
-    async def all(self) -> List[ExtendedModelData]:
+    def all(self) -> List[ExtendedModelData]:
         """Read all rows."""
         query = sql.SQL('SELECT * FROM {table}').format(
             table=self._table)
 
-        result: List[ExtendedModelData] = await self \
+        result: List[ExtendedModelData] = self \
             ._client.execute_and_return(query)
 
         return result
 
 
-class ExtendedModel(Model[ExtendedModelData]):
-    """Build an ExampleItem Model instance."""
+class ExtendedModel(SyncModel[ExtendedModelData]):
+    """Build an ExampleItem SyncModel instance."""
 
     read: ExtendedReader
     create: ExtendedCreator
 
-    def __init__(self, client: Client) -> None:
+    def __init__(self, client: SyncClient) -> None:
         super().__init__(client, 'extended_model')
         self.read = ExtendedReader(self.client, self.table)
         self.create = ExtendedCreator(self.client, self.table)