Class and Object Terms

The foundations of Object-Oriented Programming is defining a Class

  • In Object-Oriented Programming (OOP), a class is a blueprint for creating an Object. (a data structure). An Object is used like many other Python variables.
  • A Class has ...
    • a collection of data, these are called Attributes and in Python are pre-fixed using the keyword self
    • a collection of Functions/Procedures. These are called *Methods when they exist inside a Class definition.
  • An Object is created from the Class/Template. Characteristics of objects ...
    • an Object is an Instance of the Class/Template
    • there can be many Objects created from the same Class
    • each Object contains its own Instance Data
    • the data is setup by the Constructor, this is the "init" method in a Python class
    • all methods in the Class/Template become part of the Object, methods are accessed using dot notation (object.method())
  • A Python Class allow for the definition of @ decorators, these allow access to instance data without the use of functions ...
    • @property decorator (aka getter). This enables developers to reference/get instance data in a shorthand fashion (object.name versus object.get_name())
    • @name.setter decorator (aka setter). This enables developers to update/set instance data in a shorthand fashion (object.name = "John" versus object.set_name("John"))
    • observe all instance data (self._name, self.email ...) are prefixed with "", this convention allows setters and getters to work with more natural variable name (name, email ...)

Class and Object Code

# Werkzeug is a collection of libraries that can be used to create a WSGI (Web Server Gateway Interface)
# A gateway in necessary as a web server cannot communicate directly with Python.
# In this case, imports are focused on generating hash code to protect passwords.
from werkzeug.security import generate_password_hash, check_password_hash
import json

# Define a User Class/Template
# -- A User represents the data we want to manage
class User:    
    # constructor of a User object, initializes the instance variables within object (self)
    def __init__(self, name, uid, password):
        self._name = name    # variables with self prefix become part of the object, 
        self._uid = uid
        self.set_password(password)

    # 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
    
    # output content using str(object) in human readable form, uses getter
    def __str__(self):
        return f'name: "{self.name}", id: "{self.uid}", psw: "{self.password}"'

    # output command to recreate the object, uses attribute directly
    def __repr__(self):
        return f'Person(name={self._name}, uid={self._uid}, password={self._password})'


# tester method to print users
def tester(users, uid, psw):
    result = None
    for user in users:
        # test for match in database
        if user.uid == uid and user.is_password(psw):  # check for match
            print("* ", end="")
            result = user
        # print using __str__ method
        print(str(user))
    return result
        

# place tester code inside of special if!  This allows include without tester running
if __name__ == "__main__":

    # define user objects
    u1 = User(name='Thomas Edison', uid='toby', password='123toby')
    u2 = User(name='Nicholas Tesla', uid='nick', password='123nick')
    u3 = User(name='Alexander Graham Bell', uid='lex', password='123lex')
    u4 = User(name='Eli Whitney', uid='eli', password='123eli')
    u5 = User(name='Hedy Lemarr', uid='hedy', password='123hedy')

    # put user objects in list for convenience
    users = [u1, u2, u3, u4, u5]

    # Find user
    print("Test 1, find user 3")
    u = tester(users, u3.uid, "123lex")


    # Change user
    print("Test 2, change user 3")
    u.name = "John Mortensen"
    u.uid = "jm1021"
    u.set_password("123qwerty")
    u = tester(users, u.uid, "123qwerty")


    # Make dictionary
    ''' 
    The __dict__ in Python represents a dictionary or any mapping object that is used to store the attributes of the object. 
    Every object in Python has an attribute that is denoted by __dict__. 
    Use the json.dumps() method to convert the list of Users to a JSON string.
    '''
    print("Test 3, make a dictionary")
    json_string = json.dumps([user.__dict__ for user in users]) 
    print(json_string)

    print("Test 4, make a dictionary")
    json_string = json.dumps([vars(user) for user in users]) 
    print(json_string)
Test 1, find user 3
name: "Thomas Edison", id: "toby", psw: "sha256$tA6..."
name: "Nicholas Tesla", id: "nick", psw: "sha256$5x1..."
* name: "Alexander Graham Bell", id: "lex", psw: "sha256$7w4..."
name: "Eli Whitney", id: "eli", psw: "sha256$TSc..."
name: "Hedy Lemarr", id: "hedy", psw: "sha256$cM4..."
Test 2, change user 3
name: "Thomas Edison", id: "toby", psw: "sha256$tA6..."
name: "Nicholas Tesla", id: "nick", psw: "sha256$5x1..."
* name: "John Mortensen", id: "jm1021", psw: "sha256$AwH..."
name: "Eli Whitney", id: "eli", psw: "sha256$TSc..."
name: "Hedy Lemarr", id: "hedy", psw: "sha256$cM4..."
Test 3, make a dictionary
[{"_name": "Thomas Edison", "_uid": "toby", "_password": "sha256$tA66LGOW4sOyLtRS$924d9e6fc8ac471f858f5f8c63d7a752c27de954abb8ab7d0fa559b196e64820"}, {"_name": "Nicholas Tesla", "_uid": "nick", "_password": "sha256$5x19YGkGXOEpV4ob$8c838a728227ec747b1a09bb19854f3d6d1cb8ca8b604d02763934260ed6c6f3"}, {"_name": "John Mortensen", "_uid": "jm1021", "_password": "sha256$AwHd6x0W2yhF46fW$9142757bc1c66494906012dc721eb8f0cc7d61674c15acd943ea4b90d6156de8"}, {"_name": "Eli Whitney", "_uid": "eli", "_password": "sha256$TScTk47lL3JyJwy8$976928361417278fcd9d003b16e2f5bad5f32d7a8a59218e21e012e64c307944"}, {"_name": "Hedy Lemarr", "_uid": "hedy", "_password": "sha256$cM4Eys3EtZEzspH3$03f9d89d6e81753afe875cb2436032813b44ae5cae5fcf6d06d5a71c5ce2e114"}]
Test 4, make a dictionary
[{"_name": "Thomas Edison", "_uid": "toby", "_password": "sha256$tA66LGOW4sOyLtRS$924d9e6fc8ac471f858f5f8c63d7a752c27de954abb8ab7d0fa559b196e64820"}, {"_name": "Nicholas Tesla", "_uid": "nick", "_password": "sha256$5x19YGkGXOEpV4ob$8c838a728227ec747b1a09bb19854f3d6d1cb8ca8b604d02763934260ed6c6f3"}, {"_name": "John Mortensen", "_uid": "jm1021", "_password": "sha256$AwHd6x0W2yhF46fW$9142757bc1c66494906012dc721eb8f0cc7d61674c15acd943ea4b90d6156de8"}, {"_name": "Eli Whitney", "_uid": "eli", "_password": "sha256$TScTk47lL3JyJwy8$976928361417278fcd9d003b16e2f5bad5f32d7a8a59218e21e012e64c307944"}, {"_name": "Hedy Lemarr", "_uid": "hedy", "_password": "sha256$cM4Eys3EtZEzspH3$03f9d89d6e81753afe875cb2436032813b44ae5cae5fcf6d06d5a71c5ce2e114"}]

Hacks

Add new attributes/variables to the Class. Make class specific to your CPT work.

  • Add classOf attribute to define year of graduation
    • Add setter and getter for classOf
  • Add dob attribute to define date of birth
    • This will require investigation into Python datetime objects as shown in example code below
    • Add setter and getter for dob
  • Add instance variable for age, make sure if dob changes age changes
    • Add getter for age, but don't add/allow setter for age
  • Update and format tester function to work with changes

Start a class design for each of your own Full Stack CPT sections of your project

  • Use new code cell in this notebook
  • Define init and self attributes
  • Define setters and getters
  • Make a tester

Start of Hacks

class date:

    from datetime import date

    def calculate_age(born):
        today = date.today()
        return today.year - born.year - ((today.month, today.day) < (born.month, born.day))

    dob = date(2005, 12, 13)
    age = calculate_age(dob)
    print(age)
17
class classof:
    def __init__(self, gradyear):
        self._gradyear = gradyear

    @property
    def gradyear(self):
        return self._gradyear

    @gradyear.setter
    def gradyear(self, gradyear):
        self._gradyear = gradyear

student = classof(gradyear=2024)
print("You Graduate in", student.gradyear,"!!!!")
        
You Graduate in 2024 !!!!
# A gateway in necessary as a web server cannot communicate directly with Python.
# In this case, imports are focused on generating hash code to protect passwords.
from werkzeug.security import generate_password_hash, check_password_hash
import json
# Define a User Class/Template
# -- A User represents the data we want to manage
class User:
    # constructor of a User object, initializes the instance variables within object (self)
    def __init__(self, name, uid, password, gradCLASS, dob, age):
        self._name = name    # variables with self prefix become part of the object,
        self._uid = uid
        self._gradCLASS = gradCLASS
        self._dob = dob
        self._age = age
        self.set_password(password)
    # 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
    # a name getter method, extracts name from object
    @property
    def gradCLASS(self):
        return self._gradCLASS
    # a setter function, allows name to be updated after initial object creation
    @name.setter
    def gradCLASS(self, gradCLASS):
        self._gradCLASS = gradCLASS
    # a name getter method, extracts name from object
    @property
    def age(self):
        return self._age
    # a setter function, allows name to be updated after initial object creation
    @name.setter
    def age(self, age):
        self._age = age
    # a name getter method, extracts name from object
    @property
    def dob(self):
        return self._dob
    # a setter function, allows name to be updated after initial object creation
    @name.setter
    def dob(self, dob):
        self._dob = dob
    @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
    # output content using str(object) in human readable form, uses getter
    def __str__(self):
        return f'name: "{self.name}", id: "{self.uid}", psw: "{self.password}"'
    # output command to recreate the object, uses attribute directly
    def __repr__(self):
        return f'Person(name={self._name}, uid={self._uid}, password={self._password})'
from datetime import date
def calculate_age(born):
    today = date.today()
    return today.year - born.year - ((today.month, today.day) < (born.month, born.day))
# tester method to print users
def tester(users, uid, psw, gradCLASS, dob, age):
    result = None
    for user in users:
        # test for match in database
        if user.uid == uid and user.is_password(psw):  # check for match
            print("* ", end="")
            result = user
        # print using __str__ method
        print(str(user))
    return result
# place tester code inside of special if!  This allows include without tester running
if __name__ == "__main__":
    # define user objects
    u1 = User(name='Chandram Kotturi', uid='ram', password='123ram', gradCLASS='1990', dob=(1972, 6, 9), age=calculate_age(date(1972, 6, 9)))
    u2 = User(name='Sumedh Kotturi', uid='sumedh', password='123sumedh', gradCLASS='2029', dob=(2010, 12, 8), age=calculate_age(date(2010, 12, 8)))
    u3 = User(name='Lalitha Chittila', uid='lalitha', password='123lalitha', gradCLASS='1995', dob=(1977, 6, 15), age=calculate_age(date(1977, 12, 15)))
    u4 = User(name='Srihita Kotturi', uid='sri', password='123sri', gradCLASS='2024', dob=(2005, 12, 13), age=calculate_age(date(2005, 12, 13)))
    # put user objects in list for convenience
    users = [u1, u2, u3, u4]
    # Find user
    print("Test 1, find user 3")
    u = tester(users, u3.uid, "123lalitha", u3.gradCLASS, u3.dob, u3.age)
    # Change user
    print("Test 2, change user 3")
    u.name = "John Mortensen"
    u.uid = "jm1021"
    u.set_password("123qwerty")
    u.gradyear = '2024'
    dob = '11-2-16'
    u = tester(users, u.uid, "123qwerty", u.gradCLASS, u.dob, u.age)
    # Make dictionary
    '''
    The __dict__ in Python represents a dictionary or any mapping object that is used to store the attributes of the object.
    Every object in Python has an attribute that is denoted by __dict__.
    Use the json.dumps() method to convert the list of Users to a JSON string.
    '''
    print("Test 3, make a dictionary")
    json_string = json.dumps([user.__dict__ for user in users])
    print(json_string)
    print("Test 4, make a dictionary")
    json_string = json.dumps([vars(user) for user in users])
    print(json_string)
Test 1, find user 3
name: "Chandram Kotturi", id: "ram", psw: "sha256$cI2..."
name: "Sumedh Kotturi", id: "sumedh", psw: "sha256$xXU..."
* name: "Lalitha Chittila", id: "lalitha", psw: "sha256$N36..."
name: "Srihita Kotturi", id: "sri", psw: "sha256$4Jf..."
Test 2, change user 3
name: "Chandram Kotturi", id: "ram", psw: "sha256$cI2..."
name: "Sumedh Kotturi", id: "sumedh", psw: "sha256$xXU..."
* name: "John Mortensen", id: "jm1021", psw: "sha256$Zou..."
name: "Srihita Kotturi", id: "sri", psw: "sha256$4Jf..."
Test 3, make a dictionary
[{"_name": "Chandram Kotturi", "_uid": "ram", "_gradCLASS": "1990", "_dob": [1972, 6, 9], "_age": 50, "_password": "sha256$cI23xuJMw3chad9v$01340b1736f40f20c69d889c0f1914ad1a07c7287fda77a3799c7bd0e6811e85"}, {"_name": "Sumedh Kotturi", "_uid": "sumedh", "_gradCLASS": "2029", "_dob": [2010, 12, 8], "_age": 12, "_password": "sha256$xXUyjAfLG0bW5jv9$7a3683e367686ebe119ce0f961ce7ae3df2686ed31e82a0369d3c56cff3f38f5"}, {"_name": "John Mortensen", "_uid": "jm1021", "_gradCLASS": "1995", "_dob": [1977, 6, 15], "_age": 45, "_password": "sha256$ZouUOGFUVM9ttZGh$77b092106a01bd5b57cf3451729fcec5e18d20fa6388fa3170551342ecbc732f", "gradyear": "2024"}, {"_name": "Srihita Kotturi", "_uid": "sri", "_gradCLASS": "2024", "_dob": [2005, 12, 13], "_age": 17, "_password": "sha256$4JfICJtW9zTbRVon$64ff6c11ffc357fc3469cf0102d0f1e3f5afa744f245b8d102cc38fb75d40d10"}]
Test 4, make a dictionary
[{"_name": "Chandram Kotturi", "_uid": "ram", "_gradCLASS": "1990", "_dob": [1972, 6, 9], "_age": 50, "_password": "sha256$cI23xuJMw3chad9v$01340b1736f40f20c69d889c0f1914ad1a07c7287fda77a3799c7bd0e6811e85"}, {"_name": "Sumedh Kotturi", "_uid": "sumedh", "_gradCLASS": "2029", "_dob": [2010, 12, 8], "_age": 12, "_password": "sha256$xXUyjAfLG0bW5jv9$7a3683e367686ebe119ce0f961ce7ae3df2686ed31e82a0369d3c56cff3f38f5"}, {"_name": "John Mortensen", "_uid": "jm1021", "_gradCLASS": "1995", "_dob": [1977, 6, 15], "_age": 45, "_password": "sha256$ZouUOGFUVM9ttZGh$77b092106a01bd5b57cf3451729fcec5e18d20fa6388fa3170551342ecbc732f", "gradyear": "2024"}, {"_name": "Srihita Kotturi", "_uid": "sri", "_gradCLASS": "2024", "_dob": [2005, 12, 13], "_age": 17, "_password": "sha256$4JfICJtW9zTbRVon$64ff6c11ffc357fc3469cf0102d0f1e3f5afa744f245b8d102cc38fb75d40d10"}]
from werkzeug.security import generate_password_hash, check_password_hash
from datetime import date
import json

class User:    

    def __init__(self, name, uid, password, dob, gradyear):
        self._name = name    # variables with self prefix become part of the object, 
        self._uid = uid
        self.set_password(password)
        self._dob = dob
        self._gradyear = gradyear
    
    @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

    @property
    def gradyear(self):
        return self._gradyear
    
    # a setter function, allows name to be updated after initial object creation
    @gradyear.setter
    def gradyear(self, gradyear):
        self._gradyear = gradyear
    
    # 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
    
    # 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):
        self._dob = dob
        
    # age is calculated and returned each time it is accessed
    @property
    def age(self):
        today = date.today()
        return today.year - self._dob.year - ((today.month, today.day) < (self._dob.month, self._dob.day))
    
    # dictionary is customized, removing password for security purposes
    @property
    def dictionary(self):
        dict = {
            "name" : self.name,
            "uid" : self.uid,
            "dob" : self.dob,
            "age" : self.age,
            "gradyear" : self.gradyear
        }
        return dict
    
    # 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
    
    # output content using json dumps, this is ready for API response
    def __str__(self):
        return json.dumps(self.dictionary)
    
    # output command to recreate the object, uses attribute directly
    def __repr__(self):
        return f'User(name={self._name}, uid={self._uid}, password={self._password},dob={self._dob}, gradyear={self.gradyear})'
    

if __name__ == "__main__":
    u1 = User(name='Srihita Kotturi', uid='sri', password='123sri', dob=date(2005, 12, 13), gradyear = 2024)
    print("JSON ready string:\n", u1, "\n") 
    print("Raw Variables of object:\n", vars(u1), "\n") 
    print("Raw Attributes and Methods of object:\n", dir(u1), "\n")
    print("Representation to Re-Create the object:\n", repr(u1), "\n") 
JSON ready string:
 {"name": "Srihita Kotturi", "uid": "sri", "dob": "12-13-2005", "age": 17, "gradyear": 2024} 

Raw Variables of object:
 {'_name': 'Srihita Kotturi', '_uid': 'sri', '_password': 'sha256$FOMYDJdPNOx2GhWE$679e51799ccb480e4ca96752f3b6d51859bf422f0ffdbfd1b6382e64e28e7c48', '_dob': datetime.date(2005, 12, 13), '_gradyear': 2024} 

Raw Attributes and Methods of object:
 ['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_dob', '_gradyear', '_name', '_password', '_uid', 'age', 'dictionary', 'dob', 'gradyear', 'is_password', 'is_uid', 'name', 'set_password', 'uid'] 

Representation to Re-Create the object:
 User(name=Srihita Kotturi, uid=sri, password=sha256$FOMYDJdPNOx2GhWE$679e51799ccb480e4ca96752f3b6d51859bf422f0ffdbfd1b6382e64e28e7c48,dob=2005-12-13, gradyear=2024)