refactoring examples

Author: krylosov-aa

examples/fastapi_example/database.py renamed to examples/database.py

@@ -1,11 +1,11 @@
 from context_async_sqlalchemy import atomic_db_session, db_session
 from sqlalchemy import insert
 
-from ..database import connection
-from ..models import ExampleTable
+from examples.database import connection
+from examples.models import ExampleTable
 
 
-async def handler_with_db_session_and_atomic() -> None:
+async def atomic_base_example() -> None:
     """
     Let's imagine you already have a function that works with a contextual
     session, and its use case calls autocommit at the end of the request.
@@ -23,7 +23,5 @@ async def handler_with_db_session_and_atomic() -> None:
 
 async def _insert_1() -> None:
     session = await db_session(connection)
-    stmt = insert(ExampleTable).values(
-        text="example_with_db_session_and_atomic"
-    )
+    stmt = insert(ExampleTable).values()
     await session.execute(stmt)

examples/fastapi_example/routes/atomic_usage.py renamed to examples/fastapi_example/routes/atomic.py

@@ -1,11 +1,11 @@
 from context_async_sqlalchemy import atomic_db_session, db_session
 from sqlalchemy import insert
 
-from ..database import connection
-from ..models import ExampleTable
+from examples.database import connection
+from examples.models import ExampleTable
 
 
-async def handler_with_db_session_and_atomic_2() -> None:
+async def atomic_and_previous_transaction() -> None:
     """
     Let's imagine you already have a function that works with a contextual
     session, and its use case calls autocommit at the end of the request.
@@ -43,7 +43,5 @@ async def handler_with_db_session_and_atomic_2() -> None:
 
 async def _insert_1() -> None:
     session = await db_session(connection)
-    stmt = insert(ExampleTable).values(
-        text="example_with_db_session_and_atomic"
-    )
+    stmt = insert(ExampleTable).values()
     await session.execute(stmt)

examples/fastapi_example/routes/atomic_usage_2.py renamed to examples/fastapi_example/routes/atomic_prev_transaction.py

@@ -1,16 +1,16 @@
 from context_async_sqlalchemy import db_session
 from sqlalchemy import insert
 
-from ..database import connection
-from ..models import ExampleTable
+from examples.database import connection
+from examples.models import ExampleTable
 
 
-async def handler_with_db_session_and_exception() -> None:
+async def auto_rollback_by_exception() -> None:
     """
     let's imagine that an exception occurred.
     """
     session = await db_session(connection)
-    stmt = insert(ExampleTable).values(text="example_with_db_session")
+    stmt = insert(ExampleTable)
     await session.execute(stmt)
 
     raise Exception("Some exception")

examples/fastapi_example/routes/simple_with_exception.py renamed to examples/fastapi_example/routes/auto_rollback_by_exception.py

@@ -3,13 +3,13 @@
 from context_async_sqlalchemy import db_session
 from sqlalchemy import insert
 
-from ..database import connection
-from ..models import ExampleTable
+from examples.database import connection
+from examples.models import ExampleTable
 
 
-async def handler_with_db_session_and_http_exception() -> None:
+async def auto_rollback_by_status_code() -> None:
     """
-    let's imagine that an http exception occurred.
+    let's imagine that an error code was returned.
     """
     session = await db_session(connection)
     stmt = insert(ExampleTable).values(text="example_with_db_session")

examples/fastapi_example/routes/simple_with_http_exception.py renamed to examples/fastapi_example/routes/auto_rollback_by_status_code.py

@@ -10,11 +10,11 @@
 )
 from sqlalchemy import insert
 
-from ..database import connection
-from ..models import ExampleTable
+from examples.database import connection
+from examples.models import ExampleTable
 
 
-async def handler_multiple_sessions() -> None:
+async def concurrent_queries() -> None:
     """
     In some situations, you need to have multiple sessions running
         simultaneously. For example, to run several queries concurrently.

examples/fastapi_example/routes/multiple_session_usage.py renamed to examples/fastapi_example/routes/councurrent_queries.py

@@ -5,11 +5,11 @@
 )
 from sqlalchemy import insert
 
-from ..database import connection
-from ..models import ExampleTable
+from examples.database import connection
+from examples.models import ExampleTable
 
 
-async def handler_with_db_session_and_manual_close() -> None:
+async def early_commit() -> None:
     """
     An example of a handle that uses a session in context,
         but commits manually and even closes the session to release the
@@ -28,9 +28,7 @@ async def handler_with_db_session_and_manual_close() -> None:
 
 async def _insert_1() -> None:
     session = await db_session(connection)
-    stmt = insert(ExampleTable).values(
-        text="example_with_db_session_and_manual_close"
-    )
+    stmt = insert(ExampleTable)
     await session.execute(stmt)
 
     # Here we closed the transaction
@@ -39,9 +37,7 @@ async def _insert_1() -> None:
 
 async def _insert_2() -> None:
     session = await db_session(connection)
-    stmt = insert(ExampleTable).values(
-        text="example_with_db_session_and_manual_close"
-    )
+    stmt = insert(ExampleTable)
     await session.execute(stmt)
 
     # Here we closed the transaction
@@ -56,7 +52,5 @@ async def _insert_2() -> None:
 
 async def _insert_3() -> None:
     session = await db_session(connection)
-    stmt = insert(ExampleTable).values(
-        text="example_with_db_session_and_manual_close"
-    )
+    stmt = insert(ExampleTable)
     await session.execute(stmt)

examples/fastapi_example/routes/manual_commit.py renamed to examples/fastapi_example/routes/early_commit.py

@@ -5,11 +5,11 @@
 )
 from sqlalchemy import insert
 
-from ..database import connection
-from ..models import ExampleTable
+from examples.database import connection
+from examples.models import ExampleTable
 
 
-async def handler_with_early_connection_close() -> None:
+async def early_connection_close() -> None:
     """
     An example when you can return a connection to the connection pool for a
         long period of work unrelated to the database

examples/fastapi_example/routes/early_connection_close.py

@@ -1,11 +1,11 @@
 from context_async_sqlalchemy import db_session, rollback_db_session
 from sqlalchemy import insert
 
-from ..database import connection
-from ..models import ExampleTable
+from examples.database import connection
+from examples.models import ExampleTable
 
 
-async def handler_with_db_session_and_manual_rollback() -> None:
+async def early_rollback() -> None:
     """
     An example of a handle that uses a rollback
     """
@@ -21,7 +21,5 @@ async def handler_with_db_session_and_manual_rollback() -> None:
 
 async def _insert() -> None:
     session = await db_session(connection)
-    stmt = insert(ExampleTable).values(
-        text="example_with_db_session_and_manual_close"
-    )
+    stmt = insert(ExampleTable)
     await session.execute(stmt)

examples/fastapi_example/routes/manual_rollback.py renamed to examples/fastapi_example/routes/early_rollback.py

@@ -2,11 +2,11 @@
 
 from context_async_sqlalchemy import db_session
 
-from ..database import connection
-from ..models import ExampleTable
+from examples.database import connection
+from examples.models import ExampleTable
 
 
-async def handler_with_db_session() -> None:
+async def simple_usage() -> None:
     """
     An example of a typical handle that uses a context session to work with
         a database.
@@ -18,7 +18,7 @@ async def handler_with_db_session() -> None:
     # even in child coroutines.
     session = await db_session(connection)
 
-    stmt = insert(ExampleTable).values(text="example_with_db_session")
+    stmt = insert(ExampleTable)
 
     # On the first request, a connection and transaction were opened
     await session.execute(stmt)