Database and SQLAlchemy

In this blog we will explore using programs with data, focused on Databases. We will use SQLite Database to learn more about using Programs with Data.

  • College Board talks about ideas like

    • Program Usage. "iterative and interactive way when processing information"
    • Managing Data. "classifying data are part of the process in using programs", "data files in a Table"
    • Insight "insight and knowledge can be obtained from ... digitally represented information"
    • Filter systems. 'tools for finding information and recognizing patterns"
    • Application. "the preserve has two databases", "an employee wants to count the number of book"
  • PBL, Databases, Iterative/OOP

    • Iterative. Refers to a sequence of instructions or code being repeated until a specific end result is achieved
    • OOP. A computer programming model that organizes software design around data, or objects, rather than functions and logic
    • SQL. Structured Query Language, abbreviated as SQL, is a language used in programming, managing, and structuring data

Imports and Flask Objects

Defines and key object creations

  • Comment on where you have observed these working?
  1. Flask app object
  2. SQLAlchemy object
"""
These imports define the key objects
"""

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

"""
These object and definitions are used throughout the Jupyter Notebook.
"""

# Setup of key Flask object (app)
app = Flask(__name__)
# Setup SQLAlchemy object and properties for the database (db)
database = 'sqlite:///files/sqlite.db'  # path and filename of database
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
app.config['SQLALCHEMY_DATABASE_URI'] = database
app.config['SECRET_KEY'] = 'SECRET_KEY'
db = SQLAlchemy()


# This belongs in place where it runs once per project
db.init_app(app)

Model Definition

Define columns, initialization, and CRUD methods for users table in sqlite.db

  • Comment on these items in the class
  • class User purpose
  • db.Model inheritance
  • init method
  • @property, @.setter</li>
  • additional methods
  • </ul>

    defining the template for users

    </div> </div> </div>
    """ database dependencies to support sqlite examples """
    import datetime
    from datetime import datetime
    import json
    
    from sqlalchemy.exc import IntegrityError
    from werkzeug.security import generate_password_hash, check_password_hash
    
    
    ''' Tutorial: https://www.sqlalchemy.org/library.html#tutorials, try to get into a Python shell and follow along '''
    
    # Define the User class to manage actions in the 'users' table
    # -- Object Relational Mapping (ORM) is the key concept of SQLAlchemy
    # -- a.) db.Model is like an inner layer of the onion in ORM
    # -- b.) User represents data we want to store, something that is built on db.Model
    # -- c.) SQLAlchemy ORM is layer on top of SQLAlchemy Core, then SQLAlchemy engine, SQL
    class User(db.Model):
        __tablename__ = 'users'  # table name is plural, class name is singular
    
        # Define the User schema with "vars" from object
        id = db.Column(db.Integer, primary_key=True)
        _name = db.Column(db.String(255), unique=False, nullable=False)
        _uid = db.Column(db.String(255), unique=True, nullable=False)
        _password = db.Column(db.String(255), unique=False, nullable=False)
        _dob = db.Column(db.Date)
    
        # constructor of a User object, initializes the instance variables within object (self)
        def __init__(self, name, uid, password="123qwerty", dob=datetime.today()):
            self._name = name    # variables with self prefix become part of the object, 
            self._uid = uid
            self.set_password(password)
            if isinstance(dob, str):  # not a date type     
                dob = date=datetime.today()
            self._dob = dob
    
        # a name getter method, extracts name from object
        @property
        def name(self):
            return self._name
        
        # a setter function, allows name to be updated after initial object creation
        @name.setter
        def name(self, name):
            self._name = name
        
        # a getter method, extracts email from object
        @property
        def uid(self):
            return self._uid
        
        # a setter function, allows name to be updated after initial object creation
        @uid.setter
        def uid(self, uid):
            self._uid = uid
            
        # check if uid parameter matches user id in object, return boolean
        def is_uid(self, uid):
            return self._uid == uid
        
        @property
        def password(self):
            return self._password[0:10] + "..." # because of security only show 1st characters
    
        # update password, this is conventional setter
        def set_password(self, password):
            """Create a hashed password."""
            self._password = generate_password_hash(password, method='sha256')
    
        # check password parameter versus stored/encrypted password
        def is_password(self, password):
            """Check against hashed password."""
            result = check_password_hash(self._password, password)
            return result
        
        # dob property is returned as string, to avoid unfriendly outcomes
        @property
        def dob(self):
            dob_string = self._dob.strftime('%m-%d-%Y')
            return dob_string
        
        # dob should be have verification for type date
        @dob.setter
        def dob(self, dob):
            if isinstance(dob, str):  # not a date type     
                dob = date=datetime.today()
            self._dob = dob
        
        @property
        def age(self):
            today = datetime.today()
            return today.year - self._dob.year - ((today.month, today.day) < (self._dob.month, self._dob.day))
        
        # output content using str(object) in human readable form, uses getter
        # output content using json dumps, this is ready for API response
        def __str__(self):
            return json.dumps(self.read())
    
        # CRUD create/add a new record to the table
        # returns self or None on error
        def create(self):
            try:
                # creates a person object from User(db.Model) class, passes initializers
                db.session.add(self)  # add prepares to persist person object to Users table
                db.session.commit()  # SqlAlchemy "unit of work pattern" requires a manual commit
                return self
            except IntegrityError:
                db.session.remove()
                return None
    
        # CRUD read converts self to dictionary
        # returns dictionary
        def read(self):
            return {
                "id": self.id,
                "name": self.name,
                "uid": self.uid,
                "dob": self.dob,
                "age": self.age,
            }
    
        # CRUD update: updates user name, password, phone
        # returns self
        def update(self, name="", uid="", password=""):
            """only updates values with length"""
            if len(name) > 0:
                self.name = name
            if len(uid) > 0:
                self.uid = uid
            if len(password) > 0:
                self.set_password(password)
            db.session.add(self)
            db.session.commit()
            return self
    
        # CRUD delete: remove self
        # None
        def delete(self):
            db.session.delete(self)
            db.session.commit()
            return None
        
    

    Initial Data

    Uses SQLALchemy db.create_all() to initialize rows into sqlite.db

    • Comment on how these work?
    1. Create All Tables from db Object
    2. User Object Constructors
    3. Try / Except
    """Database Creation and Testing """
    
    
    # Builds working data for testing
    def initUsers():
        with app.app_context():
            """Create database and tables"""
            db.create_all()
            """Tester data for table"""
            u1 = User(name='Thomas Edison', uid='toby', password='123toby', dob=datetime(1847, 2, 11))
            u2 = User(name='Nikola Tesla', uid='niko', password='123niko')
            u3 = User(name='Alexander Graham Bell', uid='lex', password='123lex')
            u4 = User(name='Eli Whitney', uid='whit', password='123whit')
            u5 = User(name='Indiana Jones', uid='indi', dob=datetime(1920, 10, 21))
            u6 = User(name='Marion Ravenwood', uid='raven', dob=datetime(1921, 10, 21))
    
    
            users = [u1, u2, u3, u4, u5, u6]
    
            """Builds sample user/note(s) data"""
            for user in users:
                try:
                    '''add user to table'''
                    object = user.create()
                    print(f"Created new uid {object.uid}")
                except:  # error raised if object nit created
                    '''fails with bad or duplicate data'''
                    print(f"Records exist uid {user.uid}, or error.")
                    
    initUsers()
    
    Created new uid toby
    Created new uid niko
    Created new uid lex
    Created new uid whit
    Created new uid indi
    Created new uid raven
    

    Check for given Credentials in users table in sqlite.db

    Use of ORM Query object and custom methods to identify user to credentials uid and password

    • Comment on purpose of following
    1. User.query.filter_by
    2. user.password
    def find_by_uid(uid):
        with app.app_context():
            user = User.query.filter_by(_uid=uid).first()
        return user # returns user object
    
    # Check credentials by finding user and verify password
    def check_credentials(uid, password):
        # query email and return user record
        user = find_by_uid(uid)
        if user == None:
            return False
        if (user.is_password(password)):
            return True
        return False
            
    #check_credentials("indi", "123qwerty")
    

    Create a new User in table in Sqlite.db

    Uses SQLALchemy and custom user.create() method to add row.

    • Comment on purpose of following
    1. user.find_by_uid() and try/except
    2. user = User(...)
    3. user.dob and try/except
    4. user.create() and try/except
    def create():
        # optimize user time to see if uid exists
        uid = input("Enter your user id:")
        user = find_by_uid(uid)
        try:
            print("Found\n", user.read())
            return
        except:
            pass # keep going
        
        # request value that ensure creating valid object
        name = input("Enter your name:")
        password = input("Enter your password")
        
        # Initialize User object before date
        user = User(name=name, 
                    uid=uid, 
                    password=password
                    )
        
        # create user.dob, fail with today as dob
        dob = input("Enter your date of birth 'YYYY-MM-DD'")
        try:
            user.dob = datetime.strptime(dob, '%Y-%m-%d').date()
        except ValueError:
            user.dob = datetime.today()
            print(f"Invalid date {dob} require YYYY-mm-dd, date defaulted to {user.dbo}")
               
        # write object to database
        with app.app_context():
            try:
                object = user.create()
                print("Created\n", object.read())
            except:  # error raised if object not created
                print("Unknown error uid {uid}")
            
    create()
    
    ---------------------------------------------------------------------------
    ValueError                                Traceback (most recent call last)
    /Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb Cell 12 in create()
         <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X14sZmlsZQ%3D%3D?line=23'>24</a> try:
    ---> <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X14sZmlsZQ%3D%3D?line=24'>25</a>     user.dob = datetime.strptime(dob, '%Y-%m-%d').date()
         <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X14sZmlsZQ%3D%3D?line=25'>26</a> except ValueError:
    
    File /opt/homebrew/Cellar/python@3.10/3.10.9/Frameworks/Python.framework/Versions/3.10/lib/python3.10/_strptime.py:568, in _strptime_datetime(cls, data_string, format)
        566 """Return a class cls instance based on the input string and the
        567 format string."""
    --> 568 tt, fraction, gmtoff_fraction = _strptime(data_string, format)
        569 tzname, gmtoff = tt[-2:]
    
    File /opt/homebrew/Cellar/python@3.10/3.10.9/Frameworks/Python.framework/Versions/3.10/lib/python3.10/_strptime.py:349, in _strptime(data_string, format)
        348 if not found:
    --> 349     raise ValueError("time data %r does not match format %r" %
        350                      (data_string, format))
        351 if len(data_string) != found.end():
    
    ValueError: time data '' does not match format '%Y-%m-%d'
    
    During handling of the above exception, another exception occurred:
    
    AttributeError                            Traceback (most recent call last)
    /Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb Cell 12 in <cell line: 38>()
         <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X14sZmlsZQ%3D%3D?line=34'>35</a>         except:  # error raised if object not created
         <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X14sZmlsZQ%3D%3D?line=35'>36</a>             print("Unknown error uid {uid}")
    ---> <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X14sZmlsZQ%3D%3D?line=37'>38</a> create()
    
    /Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb Cell 12 in create()
         <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X14sZmlsZQ%3D%3D?line=25'>26</a> except ValueError:
         <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X14sZmlsZQ%3D%3D?line=26'>27</a>     user.dob = datetime.today()
    ---> <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X14sZmlsZQ%3D%3D?line=27'>28</a>     print(f"Invalid date {dob} require YYYY-mm-dd, date defaulted to {user.dbo}")
         <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X14sZmlsZQ%3D%3D?line=29'>30</a> # write object to database
         <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X14sZmlsZQ%3D%3D?line=30'>31</a> with app.app_context():
    
    AttributeError: 'User' object has no attribute 'dbo'

    Reading users table in sqlite.db

    Uses SQLALchemy query.all method to read data

    • Comment on purpose of following
    1. User.query.all
    2. json_ready assignment
    # SQLAlchemy extracts all users from database, turns each user into JSON
    def read():
        with app.app_context():
            table = User.query.all()
        json_ready = [user.read() for user in table] # each user adds user.read() to list
        return json_ready
    
    read()
    
    [{'id': 1,
      'name': 'Thomas Edison',
      'uid': 'toby',
      'dob': '02-11-1847',
      'age': 176},
     {'id': 2,
      'name': 'Nikola Tesla',
      'uid': 'niko',
      'dob': '03-14-2023',
      'age': 0},
     {'id': 3,
      'name': 'Alexander Graham Bell',
      'uid': 'lex',
      'dob': '03-14-2023',
      'age': 0},
     {'id': 4,
      'name': 'Eli Whitney',
      'uid': 'whit',
      'dob': '03-14-2023',
      'age': 0},
     {'id': 5,
      'name': 'Indiana Jones',
      'uid': 'indi',
      'dob': '10-21-1920',
      'age': 102},
     {'id': 6,
      'name': 'Marion Ravenwood',
      'uid': 'raven',
      'dob': '10-21-1921',
      'age': 101},
     {'id': 7, 'name': 'Claire', 'uid': 'clairez', 'dob': '09-02-2005', 'age': 17}]

    Hacks

    • Add this Blog to you own Blogging site. In the Blog add notes and observations on each code cell.
    • Add Update functionality to this blog.
    • Add Delete functionality to this blog.

    Delete functionality

    def delete():
        # optimize user time to see if uid exists
        uid = input("Enter your user id:")
        user = find_by_uid(uid)
    
        if user is None:
            print(f"User {uid} is not found :(")
    
        with app.app_context():
            try:
                user.delete()
                print(f"User {uid} has been deleted.")
            except:
                print(f"There was an problem in deleting user {uid}")
            
    delete()
    
    User toby has been deleted.
    

    Update functionality

    def update():
        # optimize user time to see if uid exists
        uid = input("Enter your user id:")
        user = find_by_uid(uid)
    
        if user is None:
            print(f"User {uid} is not found :(")
            return
        print(user)
    
        new_name = input("What is your new name: ")
        new_uid = input("What is your new uid: ")
        new_password = input("What is your new password: ")
    
        with app.app_context():
            try:
                user.update(new_name, new_uid, new_password)
                print(f"User {uid} has been updated.")
            except:
                print(f"There was an problem in updating user {uid}")
            
    update()
    
    ---------------------------------------------------------------------------
    NameError                                 Traceback (most recent call last)
    /Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb Cell 19 in <cell line: 23>()
         <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X24sZmlsZQ%3D%3D?line=19'>20</a>         except:
         <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X24sZmlsZQ%3D%3D?line=20'>21</a>             print(f"There was an problem in updating user {uid}")
    ---> <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X24sZmlsZQ%3D%3D?line=22'>23</a> update()
    
    /Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb Cell 19 in update()
          <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X24sZmlsZQ%3D%3D?line=1'>2</a> def update():
          <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X24sZmlsZQ%3D%3D?line=2'>3</a>     # optimize user time to see if uid exists
          <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X24sZmlsZQ%3D%3D?line=3'>4</a>     uid = input("Enter your user id:")
    ----> <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X24sZmlsZQ%3D%3D?line=4'>5</a>     user = find_by_uid(uid)
          <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X24sZmlsZQ%3D%3D?line=6'>7</a>     if user is None:
          <a href='vscode-notebook-cell:/Users/gracewang/vscode/repository_1/_notebooks/2023-03-13-AP-unit2-4a.ipynb#X24sZmlsZQ%3D%3D?line=7'>8</a>         print(f"User {uid} is not found :(")
    
    NameError: name 'find_by_uid' is not defined
    </div>