Laboratory 7

Laboratory Objectives

1. Write Python code using any editor.
2. Execute the program from the command line.
3. Unit test the program.
4. Upload on Canvas for submission

Getting Started

1. Setting Up Python Environment

   • Verify Python Installation:
   • Open your terminal (Command Prompt for Windows, Terminal for macOS/Linux).
   • Type python --version and press Enter.
   • You should see the installed Python version displayed.

2. Configuring Visual Studio Code (VS Code)

   • Install Python Extension:
   • Open VS Code.
   • Go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window or by pressing Ctrl+Shift+X.
   • Search for Python in the Extensions Marketplace.
   • Click “Install” on the Python extension by Microsoft.

3. Running Python in VS Code

   • Create a New Python File:
   • In VS Code, open a folder where you want to save your Python projects.
   • Click on File > New File or press Ctrl+N to create a new file.
   • Save the file with a .py extension (e.g., hello.py).

Program Instructions

1. Write a Python program that performs as a Tuffy Titan Contact List which contains a dictionary of contacts that is stored on the hard drive and that can have contacts added, modified, or deleted.

2. Create a contacts module to meet the following requirements:

   1. Create a file named contacts.py.
      1. Define a class named Contacts.
         1. Define a member function named __init__ to meet the following requirements:
            1. Take a self as a positional parameter.
            2. Take a filename as a keyword parameter.
            3. Set a member variable equal to the filename.
            4. Set a member varialbe equal to an empty data dictionary.
            5. Open the filename and load the JSON decoded contents to the empty data dictionary.
            6. Cleanly manage the FileNotFoundError if the filename does not exist.
         2. Define a member function named add_contact to meet the following requirements:
            1. Take a self as a positional parameter.
            2. Take a id as a keyword parameter.
            3. Take a first_name as a keyword parameter.
            4. Take a last_name as a keyword parameter.
            5. If the id exists in the data dictionary, return the string error.
            6. Set the id:[first_name, last_name] key:value pair to the data dictionary.
            7. Sort the data dictionary in ascending order by last name, and then by first name, ignoring case.
            8. Write the contents of the data dictionary to the filename that was set to the member variable.
            9. Return the key:value pair that was added.
         3. Define a member function named modify_contact to meet the following requirements:
            1. Take a self as a positional parameter.
            2. Take a id as a keyword parameter.
            3. Take a first_name as a keyword parameter.
            4. Take a last_name as a keyword parameter.
            5. If the id does not exists in the dictionary, return the string error.
            6. Set the id:[first_name, last_name'] key:value pair to the contact dictionary.
            7. Sort the data dictionary in ascending order by last name, and then by first name, ignoring case.
            8. Write the contents of the data dictionary to the filename that was set to the member variable.
            9. Return the key:value pair that was modified.
         4. Define a member function named delete_contact to meet the following requirements:
            1. Take a self as a positional parameter.
            2. Take a id as a keyword parameter.
            3. If the id does not exists in the dictionary, return the string error.
            4. Remove the key:value pair with the key equal to id.
            5. Write the contents of the data dictionary to the filename that was set to the member variable.
            6. Return the key:value pair with the key equal to id.

3. Create a main driver program to meet the following requirements:

   1. Create a file named main.py.
   2. Import the contacts module.
   3. Instantiate a Contacts object with any default filename.
   4. Implement a menu within a loop with following choices:
      1. Add contact
      2. Modify contact
      3. Delete contact
      4. Print contact list
      5. Set contact filename
      6. Exit the program
   5. Prompt the user for the menu choice.
   6. Prompt the user for the information needed for the appropriate Contacts member function and call the function.
   7. Print out appropriate errors with function return values of error.

4. Run the program using the command below and repeat the steps above until you are satisfied your program output meets the above requirements.

   python3 -m main
   

5. Typical input and output for the program:

         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 1
   
   Enter phone number: 7145551212
   Enter first name: Steve
   Enter last name: Jobs
   Added: Steve Jobs.
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 1
   
   Enter phone number: 5625553333
   Enter first name: Bill
   Enter last name: Gates
   Added: Bill Gates.
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 4
   
   ==================== CONTACT LIST ====================
   Last Name             First Name            Phone
   ====================  ====================  ==========
   Gates                 Bill                  5625553333  
   Jobs                  Steve                 7145551212  
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 1
   
   Enter phone number: 7145551111
   Enter first name: Alpha
   Enter last name: Jobs
   Added: Alpha Jobs.
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 4
   
   ==================== CONTACT LIST ====================
   Last Name             First Name            Phone
   ====================  ====================  ==========
   Gates                 Bill                  5625553333  
   Jobs                  Alpha                 7145551111  
   Jobs                  Steve                 7145551212  
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 1
   
   Enter phone number: 7145551111
   Enter first name: Richard
   Enter last name: Stallman
   Phone number already exists.
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 2
   
   Enter phone number: 7145551111
   Enter first name: Richard
   Enter last name: Stallman
   Modified: Richard Stallman.
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 4
   
   ==================== CONTACT LIST ====================
   Last Name             First Name            Phone
   ====================  ====================  ==========
   Gates                 Bill                  5625553333  
   Jobs                  Steve                 7145551212  
   Stallman              Richard               7145551111  
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 3
   
   Enter phone number: 5625553333
   Deleted: Bill Gates.
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 4
   
   ==================== CONTACT LIST ====================
   Last Name             First Name            Phone
   ====================  ====================  ==========
   Jobs                  Steve                 7145551212  
   Stallman              Richard               7145551111  
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 3
   
   Enter phone number: 7145559999
   Invalid phone number.
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 4
   
   ==================== CONTACT LIST ====================
   Last Name             First Name            Phone
   ====================  ====================  ==========
   Jobs                  Steve                 7145551212  
   Stallman              Richard               7145551111  
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Add contact
   2. Modify contact
   3. Delete contact
   4. Print contact list
   5. Set contact filename
   6. Exit the program
   
   Enter menu choice: 6
   

6. Run the unit testing program to ensure that your program runs as expected.

   For Linux and Mac users

   ./test.sh or source ./test.sh
   

   For windows users

   ./win_test.bat
   

   The unit testing will output the results of a series of tests using specific input and expected output. Any error will provide information on where the expected output is different from the actual output. You will need to edit your source code to fix the error and run ./test.sh or ./win_test.bat repeatedly until it passes all the test.

Submission

Submit a zip file containing all the code files on canvas

Naming Convention: _.zip

Your zipped folder should contain below files:

CWID_LASTNAME.zip -
                  | > test.py
                  | > test.sh
                  | > main.py
                  | > contacts.py
                  | > test.txt
                  | > win_test.bat

Grading

1. All points add up to a total of 100 points possible as detailed below. Partial credit will be given where applicable.

Points	Description
50	Environment setup and Lab Submission
10	main.py file submitted and meets the program requirements
10	contacts.py file submitted and meets the program requirements
5	unit test passes Test01_AddContact
5	unit test passes Test02_AddContact
5	unit test passes Test03_ModifyContact
5	unit test passes Test04_ModifyContact
5	unit test passes Test05_DeleteContact
5	unit test passes Test06_DeleteContact