Update examples.

Author: andrew-chang-dewitt

example/.python-version

@@ -1 +1 @@
-3.9.1
+3.9.7

example/example/__init__.py

@@ -0,0 +1,2 @@
+from . import models
+from .main import run

example/example/example.py example/example/main.pyexample/example/example.py renamed to example/example/main.py

@@ -1,4 +1,4 @@
-"""An example of how to use Client & Model together."""
+"""An example of how to use AsyncClient & AsyncModel together."""
 
 import asyncio
 import json
@@ -7,9 +7,13 @@
 from uuid import uuid4, UUID
 from typing import Any, List
 
-from db_wrapper import ConnectionParameters, Client, Model
+from db_wrapper import ConnectionParameters, AsyncClient, AsyncModel
 
-from models import AModel, ExtendedModel, ExtendedModelData
+from example.models import (
+    AModel,
+    ExtendedModel,
+    ExtendedModelData,
+)
 
 logging.basicConfig(level=logging.INFO)
 
@@ -33,17 +37,17 @@ def default(self, obj: Any) -> Any:
     user=os.getenv('DB_USER', 'test'),
     password=os.getenv('DB_PASS', 'pass'),
     database=os.getenv('DB_NAME', 'dev'))
-client = Client(conn_params)
+client = AsyncClient(conn_params)
 
-a_model = Model[AModel](client, 'a_model')
+a_model = AsyncModel[AModel](client, 'a_model', AModel)
 extended_model = ExtendedModel(client)
 
 
 async def create_a_model_record() -> UUID:
     """
-    Show how to use a simple Model instance.
+    Show how to use a simple AsyncModel instance.
 
-    Create a new record using the default Model.create.one method.
+    Create a new record using the default AsyncModel.create.one method.
     """
     new_record = AModel(**{
         'id': uuid4(),
@@ -59,13 +63,13 @@ async def create_a_model_record() -> UUID:
 
 async def read_a_model(id_value: UUID) -> AModel:
     """Show how to read a record with a given id value."""
-    # read.one_by_id expects a string, so UUID values need
-    # converted using str()
-    return await a_model.read.one_by_id(str(id_value))
+    return await a_model.read.one_by_id(id_value)
 
 
 async def create_extended_models() -> None:
-    """Show how using an extended Model can be the same as the defaults."""
+    """
+    Show how using an extended AsyncModel can be the same as the defaults.
+    """
     dicts = [{
         'id': uuid4(),
         'string': 'something',
@@ -101,7 +105,7 @@ async 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.
+    # As a result, we can call it just like any other method on AsyncModel.read
     return await extended_model.read.all()
 
 
@@ -119,13 +123,15 @@ async def run() -> None:
         new_id = await create_a_model_record()
         created_a_model = await read_a_model(new_id)
         await create_extended_models()
-        extended_models = await read_extended_models()
+        created_extended_models = await read_extended_models()
     finally:
         await client.disconnect()
 
     # Print results to stdout
-    print(json.dumps(created_a_model, cls=UUIDJsonEncoder))
-    print(json.dumps(extended_models, cls=UUIDJsonEncoder))
+    print(json.dumps(created_a_model.dict(), cls=UUIDJsonEncoder))
+    print(json.dumps([model.dict()
+                      for model in created_extended_models],
+                     cls=UUIDJsonEncoder))
 
 if __name__ == '__main__':
     # A simple app can be run using asyncio's run method.

example/example/models/extended_model.py

@@ -5,10 +5,10 @@
 
 from psycopg2 import sql
 from psycopg2.extensions import register_adapter
-from psycopg2.extras import Json
+from psycopg2.extras import Json  # type: ignore
 
 from db_wrapper import AsyncClient, AsyncModel, ModelData
-from db_wrapper.model import AsyncRead, AsyncCreate
+from db_wrapper.model import AsyncRead, AsyncCreate, RealDictRow
 
 # tell psycopg2 to adapt all dictionaries to json instead of
 # the default hstore
@@ -55,10 +55,11 @@ async def one(self, item: ExtendedModelData) -> ExtendedModelData:
             values=sql.SQL(',').join(values),
         )
 
-        result: List[ExtendedModelData] = \
+        query_result: List[RealDictRow] = \
             await self._client.execute_and_return(query)
+        result = self._return_constructor(**query_result[0])
 
-        return result[0]
+        return result
 
 
 class ExtendedReader(AsyncRead[ExtendedModelData]):
@@ -75,8 +76,10 @@ async def all_by_string(self, string: str) -> List[ExtendedModelData]:
             string=sql.Identifier(string)
         )
 
-        result: List[ExtendedModelData] = await self \
-            ._client.execute_and_return(query)
+        query_result: List[RealDictRow] = \
+            await self._client.execute_and_return(query)
+        result = [self._return_constructor(**row)
+                  for row in query_result]
 
         return result
 
@@ -85,8 +88,10 @@ async def all(self) -> List[ExtendedModelData]:
         query = sql.SQL('SELECT * FROM {table}').format(
             table=self._table)
 
-        result: List[ExtendedModelData] = await self \
-            ._client.execute_and_return(query)
+        query_result: List[RealDictRow] = \
+            await self._client.execute_and_return(query)
+        result = [self._return_constructor(**row)
+                  for row in query_result]
 
         return result
 
@@ -98,6 +103,8 @@ class ExtendedModel(AsyncModel[ExtendedModelData]):
     create: ExtendedCreator
 
     def __init__(self, client: AsyncClient) -> None:
-        super().__init__(client, 'extended_model')
-        self.read = ExtendedReader(self.client, self.table)
-        self.create = ExtendedCreator(self.client, self.table)
+        super().__init__(client, 'extended_model', ExtendedModelData)
+        self.read = ExtendedReader(
+            self.client, self.table, ExtendedModelData)
+        self.create = ExtendedCreator(
+            self.client, self.table, ExtendedModelData)

example_sync/example/__init__.py

@@ -1,2 +1,2 @@
 from . import models
-from .example import run
+from .main import run

example_sync/example/example.py example_sync/example/main.pyexample_sync/example/example.py renamed to example_sync/example/main.py

@@ -63,9 +63,7 @@ def create_a_model_record() -> UUID:
 
 def read_a_model(id_value: UUID) -> AModel:
     """Show how to read a record with a given id value."""
-    # read.one_by_id expects a string, so UUID values need
-    # converted using str()
-    return a_model.read.one_by_id(str(id_value))
+    return a_model.read.one_by_id(id_value)
 
 
 def create_extended_models() -> None:
@@ -128,8 +126,9 @@ def run() -> None:
 
     # Print results to stdout
     print(json.dumps(created_a_model.dict(), cls=UUIDJsonEncoder))
-    print(json.dumps([item.dict()
-          for item in created_extended_models], cls=UUIDJsonEncoder))
+    print(json.dumps([model.dict()
+                      for model in created_extended_models],
+                     cls=UUIDJsonEncoder))
 
 
 if __name__ == '__main__':

example_sync/example/models/extended_model.py

@@ -7,14 +7,8 @@
 from psycopg2.extensions import register_adapter
 from psycopg2.extras import Json  # type: ignore
 
-from db_wrapper import SyncClient
-from db_wrapper.model import (
-    ModelData,
-    RealDictRow,
-    SyncModel,
-    SyncRead,
-    SyncCreate
-)
+from db_wrapper import SyncClient, SyncModel, ModelData
+from db_wrapper.model import RealDictRow, SyncRead, SyncCreate
 
 # tell psycopg2 to adapt all dictionaries to json instead of
 # the default hstore