Merge pull request #1 from cheese-drawer/v2

V2

Author: andrew-chang-dewitt

db_wrapper/model.py

@@ -13,18 +13,21 @@
 )
 from uuid import UUID
 
+# third party dependencies
+from pydantic import BaseModel
+
 # internal dependency
 from .client import Client, sql
 
 
-class ModelData(TypedDict):
+class ModelData(BaseModel):
     """Base interface for ModelData to be used in Model."""
 
     # PENDS python 3.9 support in pylint
     # pylint: disable=inherit-non-class
     # pylint: disable=too-few-public-methods
 
-    _id: UUID
+    id: UUID
 
 
 # Generic doesn't need a more descriptive name
@@ -65,7 +68,7 @@ async def one(self, item: T) -> T:
         columns: List[sql.Identifier] = []
         values: List[sql.Literal] = []
 
-        for column, value in item.items():
+        for column, value in item.dict().items():
             values.append(sql.Literal(value))
 
             columns.append(sql.Identifier(column))
@@ -100,7 +103,7 @@ async def one_by_id(self, id_value: str) -> T:
         query = sql.SQL(
             'SELECT * '
             'FROM {table} '
-            'WHERE _id = {id_value};'
+            'WHERE id = {id_value};'
         ).format(
             table=self._table,
             id_value=sql.Literal(id_value)
@@ -152,7 +155,7 @@ def compose_changes(changes: Dict[str, Any]) -> sql.Composed:
         query = sql.SQL(
             'UPDATE {table} '
             'SET {changes} '
-            'WHERE _id = {id_value} '
+            'WHERE id = {id_value} '
             'RETURNING *;'
         ).format(
             table=self._table,

example/example/example.py

@@ -41,16 +41,16 @@ async def create_a_model_record() -> UUID:
 
     Create a new record using the default Model.create.one method.
     """
-    new_record: AModel = {
-        '_id': uuid4(),
+    new_record = AModel(**{
+        'id': uuid4(),
         'string': 'some string',
         'integer': 1,
         'array': ['an', 'array', 'of', 'strings'],
-    }
+    })
 
     await a_model.create.one(new_record)
 
-    return new_record['_id']
+    return new_record.id
 
 
 async def read_a_model(id_value: UUID) -> AModel:
@@ -62,28 +62,31 @@ async def read_a_model(id_value: UUID) -> AModel:
 
 async def create_extended_models() -> None:
     """Show how using an extended Model can be the same as the defaults."""
-    new_records: List[ExtendedModelData] = [{
-        '_id': uuid4(),
+    dicts = [{
+        'id': uuid4(),
         'string': 'something',
         'integer': 1,
-        'json': {'a': 1, 'b': 2, 'c': True}
+        'data': {'a': 1, 'b': 2, 'c': True}
     }, {
-        '_id': uuid4(),
+        'id': uuid4(),
         'string': 'something',
         'integer': 1,
-        'json': {'a': 1, 'b': 2, 'c': True}
+        'data': {'a': 1, 'b': 2, 'c': True}
     }, {
-        '_id': uuid4(),
+        'id': uuid4(),
         'string': 'something',
         'integer': 1,
-        'json': {'a': 1, 'b': 2, 'c': True}
+        'data': {'a': 1, 'b': 2, 'c': True}
     }, {
-        '_id': uuid4(),
+        'id': uuid4(),
         'string': 'something',
         'integer': 1,
-        'json': {'a': 1, 'b': 2, 'c': True}
+        '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:
@@ -100,8 +103,14 @@ async def read_extended_models() -> List[ExtendedModelData]:
 
 async def run() -> None:
     """Show how to make a connection, execute queries, & disconnect."""
+
+    # First, have the client make a connection to the database
     await client.connect()
 
+    # Then, execute queries using the models that were initialized
+    # with the client above.
+    # Doing this inside a try/finally block allows client to gracefully
+    # disconnect even when an exception is thrown.
     try:
         new_id = await create_a_model_record()
         created_a_model = await read_a_model(new_id)
@@ -110,6 +119,7 @@ async def run() -> None:
     finally:
         await client.disconnect()
 
+    # Print results to stdout
     print(json.dumps(created_a_model, cls=UUIDJsonEncoder))
     print(json.dumps(extended_models, cls=UUIDJsonEncoder))
 

example/example/models/a_model.sql

@@ -1,5 +1,5 @@
 CREATE TABLE IF NOT EXISTS "a_model" (
-    "_id" uuid PRIMARY KEY,
+    "id" uuid PRIMARY KEY,
     "string" varchar(255),
     "integer" smallint,
     "array" varchar(255) []

example/example/models/extended_model.py

@@ -23,7 +23,7 @@ class ExtendedModelData(ModelData):
 
     string: str
     integer: int
-    json: Dict[str, Any]
+    data: Dict[str, Any]
 
 
 class ExtendedCreator(Create[ExtendedModelData]):
@@ -34,10 +34,10 @@ class ExtendedCreator(Create[ExtendedModelData]):
     async def one(self, item: ExtendedModelData) -> ExtendedModelData:
         """Override default Model.create.one method."""
         columns: List[sql.Identifier] = []
-        values: List[sql.Identifier] = []
+        values: List[sql.Literal] = []
 
-        for column, value in item.items():
-            if column == 'json':
+        for column, value in item.dict().items():
+            if column == 'data':
                 values.append(sql.Literal(json.dumps(value)))
             else:
                 values.append(sql.Literal(value))

example/example/models/extended_model.sql

@@ -1,8 +1,8 @@
 CREATE EXTENSION hstore;
 
 CREATE TABLE IF NOT EXISTS "extended_model" (
-    "_id" uuid PRIMARY KEY,
+    "id" uuid PRIMARY KEY,
     "string" varchar(255),
     "integer" smallint,
-    "json" jsonb
+    "data" jsonb
 );

example/requirements/prod.txt

@@ -1,2 +1,2 @@
 psycopg2-binary>=2.8.6,<3.0.0
-https://github.com/cheese-drawer/lib-python-db-wrapper/releases/download/0.1.0/db-wrapper-0.1.0.tar.gz
+https://github.com/cheese-drawer/lib-python-db-wrapper/releases/download/2.0.1/db_wrapper-2.0.1-py3-none-any.whl

requirements/prod.txt

@@ -1 +1,2 @@
 aiopg>=1.1.0,<2.0.0
+pydantic>=1.8.1,<2.0.0

scripts/test

@@ -29,7 +29,7 @@ function unit {
     echo ""
 
     # run unit tests & save exit code
-    cd tests
+    cd test
     python -m unittest -b $@
     # save exit code from tests
     unit_result=$?

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="db_wrapper",
-    version="0.1.4",
+    version="2.0.1",
     author="Andrew Chang-DeWitt",
     author_email="andrew@andrew-chang-dewitt.dev",
     description="Simple wrapper on aiopg to handle postgres connections & basic Models.",
@@ -17,6 +17,7 @@
         'db_wrapper': ['py.typed']},
     install_requires=[
         'aiopg>=1.1.0,<2.0.0',
+        'pydantic>=1.8.1,<2.0.0',
     ],
     classifiers=[
         "Programming Language :: Python :: 3",