Update SQLAlchemy, refactor project.

Author: toddbirchard

Makefile

@@ -18,8 +18,7 @@ export HELP
 .PHONY: run restart deploy update format lint clean help
 
 requirements: .requirements.txt
-env: .venv/bin/activate
-
+env: ./.venv/bin/activate
 
 .requirements.txt: requirements.txt
 	$(shell . .venv/bin/activate && pip install -r requirements.txt)
@@ -42,6 +41,7 @@ deploy:
 
 .PHONY: update
 update: env
+	.venv/bin/python3 -m pip install --upgrade pip setuptools wheel
 	poetry update
 	poetry export -f requirements.txt --output requirements.txt --without-hashes
 
@@ -54,7 +54,11 @@ format: env
 
 .PHONY: lint
 lint:
-	flake8 ./app --count --select=E9,F63,F7,F82 --show-source --statistics
+	flake8 . --count \
+			--select=E9,F63,F7,F82 \
+			--exclude .git,.github,__pycache__,.pytest_cache,.venv,logs,creds,.venv,docs,logs \
+			--show-source \
+			--statistics
 
 
 .PHONY: clean

README.md

@@ -1,7 +1,7 @@
 # SQLAlchemy Tutorial
 
 ![Python](https://img.shields.io/badge/Python-v^3.8-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
-![SQLAlchemy](https://img.shields.io/badge/SQLAlchemy-v^1.3.0-blue.svg?longCache=true&logo=python&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
+![SQLAlchemy](https://img.shields.io/badge/SQLAlchemy-v^1.4.0-blue.svg?longCache=true&logo=python&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
 ![PyMySQL](https://img.shields.io/badge/PyMySQL-v^1.0.0-red.svg?longCache=true&style=flat-square&logo=scala&logoColor=white&colorA=4c566a&colorB=bf616a)
 ![GitHub Last Commit](https://img.shields.io/github/last-commit/google/skia.svg?style=flat-square&colorA=4c566a&colorB=a3be8c&logo=GitHub)
 [![GitHub Issues](https://img.shields.io/github/issues/hackersandslackers/sqlalchemy-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/sqlalchemy-tutorial/issues)

config.py

@@ -10,3 +10,6 @@
 # Database connection variables
 SQLALCHEMY_DATABASE_URI = environ.get("SQLALCHEMY_DATABASE_URI")
 SQLALCHEMY_DATABASE_PEM = environ.get("SQLALCHEMY_DATABASE_PEM")
+
+# Reset data after each run
+CLEANUP_DATA = True

database/__init__.py

@@ -1 +1 @@
-from .connect import db, session
+from .connect import engine, session

database/connect.py

@@ -5,10 +5,10 @@
 from config import SQLALCHEMY_DATABASE_PEM, SQLALCHEMY_DATABASE_URI
 
 # Create database engine
-db = create_engine(
+engine = create_engine(
     SQLALCHEMY_DATABASE_URI, connect_args={"ssl": {"key": SQLALCHEMY_DATABASE_PEM}}
 )
 
 # Create database session
-Session = sessionmaker(bind=db)
+Session = sessionmaker(bind=engine)
 session = Session()

logger.py

@@ -0,0 +1,48 @@
+"""Custom logger."""
+from sys import stdout
+
+from loguru import logger as custom_logger
+
+
+def formatter(log: dict) -> str:
+    """
+    Format log colors based on level.
+
+    :param log: Logged event stored as map containing contextual metadata.
+    :type log: dict
+    :returns: str
+    """
+    if log["level"].name == "WARNING":
+        return (
+            "<white>{time:MM-DD-YYYY HH:mm:ss}</white> | "
+            "<light-yellow>{level}</light-yellow>: "
+            "<light-white>{message}</light-white> \n"
+        )
+    elif log["level"].name == "ERROR":
+        return (
+            "<white>{time:MM-DD-YYYY HH:mm:ss}</white> | "
+            "<light-red>{level}</light-red>: "
+            "<light-white>{message}</light-white> \n"
+        )
+    elif log["level"].name == "SUCCESS":
+        return (
+            "<white>{time:MM-DD-YYYY HH:mm:ss}</white> | "
+            "<light-green>{level}</light-green>: "
+            "<light-white>{message}</light-white> \n"
+        )
+    else:
+        return (
+            "<white>{time:MM-DD-YYYY HH:mm:ss}</white> | "
+            "<fg #67c9c4>{level}</fg #67c9c4>: "
+            "<light-white>{message}</light-white> \n"
+        )
+
+
+def create_logger() -> custom_logger:
+    """Create custom logger."""
+    custom_logger.remove()
+    custom_logger.add(stdout, colorize=True, format=formatter)
+    return custom_logger
+
+
+LOGGER = create_logger()

poetry.lock

@@ -1,6 +1,7 @@
 colorama==0.4.4; python_version >= "3.5" and python_full_version < "3.0.0" and sys_platform == "win32" or sys_platform == "win32" and python_version >= "3.5" and python_full_version >= "3.5.0"
+greenlet==1.0.0; python_version >= "3" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3"
 loguru==0.5.3; python_version >= "3.5"
 pymysql==1.0.2; python_version >= "3.6"
-python-dotenv==0.15.0
-sqlalchemy==1.3.22; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.4.0")
+python-dotenv==0.16.0
+sqlalchemy==1.4.3; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.6.0")
 win32-setctime==1.0.3; sys_platform == "win32" and python_version >= "3.5"

requirements.txt

@@ -1,26 +1,33 @@
 """Run source code for each tutorial found on HackersAndSlackers."""
-from database import db, session
+from config import CLEANUP_DATA
+from logger import LOGGER
 
-from .logger import LOGGER
-from .part1_connections import fetch_job_listings, update_job_listing
-from .part2_orm_models import orm_create_user, orm_delete_user
-from .part3_relationships import get_posts, orm_create_data
+from .cleanup import cleanup_data
+from .part1_connections import execute_queries
+from .part2_orm import create_and_delete_users
+from .part3_relationships import create_relationships
 
 
 def init_script():
     """Run all scripts."""
 
     # Part 1: Executing SELECT and UPDATE queries with an SQLAlchemy engine
+    LOGGER.info("----------------------------------------------------")
     LOGGER.info("Part 1: Executing queries against an SQLAlchemy engine.")
-    fetch_job_listings(db)
-    update_job_listing(db)
+    execute_queries()
 
     # Part 2: Implementing an ORM
+    LOGGER.info("----------------------------------------------------")
     LOGGER.info("Part 2: Create and delete records from a data model.")
-    user = orm_create_user(session)
-    orm_delete_user(session, user)
+    create_and_delete_users()
 
     # Part 3: ORM relationships
+    LOGGER.info("----------------------------------------------------")
     LOGGER.info("Part 3: Utilize relationships to execute JOINs.")
-    orm_create_data(session)
-    get_posts(session)
+    create_relationships()
+
+    # OPTIONAL: Reset table data after each run
+    if CLEANUP_DATA:
+        LOGGER.info("----------------------------------------------------")
+        LOGGER.info("Purging all created data...")
+        cleanup_data()

sqlalchemy_tutorial/__init__.py

@@ -0,0 +1,27 @@
+"""Purge all data from database."""
+from sqlalchemy import text
+from sqlalchemy.exc import IntegrityError, SQLAlchemyError
+
+from database import session
+from logger import LOGGER
+
+
+def cleanup_data():
+    try:
+        session.execute(text("SET FOREIGN_KEY_CHECKS=0;"))
+        session.commit()
+        session.execute(text("TRUNCATE TABLE comment;"))
+        session.commit()
+        session.execute(text("TRUNCATE TABLE post;"))
+        session.commit()
+        session.execute(text("TRUNCATE TABLE user;"))
+        session.commit()
+        session.execute(text("SET FOREIGN_KEY_CHECKS=1;"))
+        session.commit()
+        LOGGER.success("Successfully reset all data.")
+    except IntegrityError as e:
+        LOGGER.error(e.orig)
+        raise e.orig
+    except SQLAlchemyError as e:
+        LOGGER.error(f"Unexpected error when resetting data: {e}")
+        raise e

sqlalchemy_tutorial/cleanup.py

@@ -1 +1,13 @@
-from .engines import fetch_job_listings, update_job_listing
+from database import engine
+
+from .queries import fetch_job_listings, update_job_listing
+
+
+def execute_queries():
+    """
+    Fetch and update records using raw SQL queries.
+
+    :return: None
+    """
+    fetch_job_listings(engine)
+    update_job_listing(engine)

sqlalchemy_tutorial/logger.py

@@ -0,0 +1,51 @@
+"""Execute raw SQL queries against an SQLAlchemy engine."""
+from typing import List, Optional
+
+from sqlalchemy import text
+from sqlalchemy.engine.base import Engine
+
+from logger import LOGGER
+
+
+def fetch_job_listings(engine: Engine) -> Optional[List[dict]]:
+    """
+    Select rows from database and parse as list of dicts.
+
+    :param engine: Database engine to handle raw SQL queries.
+    :type engine: engine
+
+    :return: Optional[List[dict]]
+    """
+    result = engine.execute(
+        text(
+            "SELECT job_id, agency, business_title, \
+            salary_range_from, salary_range_to \
+            FROM nyc_jobs ORDER BY RAND();"
+        )
+    )
+    rows = [dict(row) for row in result.fetchall()]
+    LOGGER.info(f"Selected {result.rowcount} rows: {rows}")
+    return rows
+
+
+def update_job_listing(engine: Engine) -> Optional[List[dict]]:
+    """
+    Update row in database with problematic characters escaped.
+
+    :param engine: Engine object representing a SQL database.
+    :type engine: engine
+
+    :return: Optional[List[dict]]
+    """
+    result = engine.execute(
+        text(
+            "UPDATE nyc_jobs SET business_title = 'Senior QA Scapegoat 🏆', \
+            job_category = 'Information? <>!#%%Technology!%%#^&%* & Telecom' \
+            WHERE job_id = 229837;"
+        )
+    )
+    LOGGER.info(
+        f"Selected {result.rowcount} row: \
+        {result}"
+    )
+    return result.rowcount

sqlalchemy_tutorial/part1_connections/__init__.py

@@ -0,0 +1,23 @@
+from database import session
+from sqlalchemy_tutorial.part2_orm.models import User
+
+from .orm import orm_create_user, orm_delete_user
+
+
+def create_and_delete_users():
+    """
+    Create a user record via SQLAlchemy's ORM, and subsequently delete it.
+
+    :return: None
+    """
+    user = User(
+        username="admin",
+        password="Password123lol",
+        email="[email protected]",
+        first_name="Todd",
+        last_name="Birchard",
+        bio="I write tutorials on the internet.",
+        avatar_url="https://storage.googleapis.com/hackersandslackers-cdn/authors/[email protected]",
+    )
+    user = orm_create_user(session, user)
+    orm_delete_user(session, user)

sqlalchemy_tutorial/part1_connections/engines.py

@@ -3,7 +3,7 @@
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.sql import func
 
-from database import db
+from database import engine
 
 Base = declarative_base()
 
@@ -30,4 +30,4 @@ def __repr__(self):
         return "<User %r>" % self.username
 
 
-Base.metadata.create_all(db)
+Base.metadata.create_all(engine)