OPS435 Python Lab 2

LAB OBJECTIVES

This lab will cover the necessary methods to allow a user to interact with a running Python script.

Objectives

Write Python code in order to:

• Accept information from users that run a Python script, such as a username or password.

• Process the inputted information using Conditional Statements.

This means that the program will completely change how it works based on the input given, an example would be, providing the correct password or providing the wrong password.

• Process the inputted information using Looping Statements.

Looping (iteration) is the ability for your program to repeatedly run the same code over and over. An example of this, could be found when you provide the incorrect password to a login page and it responds with, 3 attempts to login remaining.

INVESTIGATION 1: USER INPUT

PART 1 - User Input

In this section, you will learn how to prompt (ask) the user running the program for input or data. Although you will not be immediately be using the information that the user provided, you will use that information later in this lab to change how a Python script works in different situations.

Storing User Input In Variables

Perform the following steps:

1. Launch your Centos VM, open your code editor, and a a shell terminal (as a regular user) for executing your code.
2. To begin, let's start out with a very basic script. This script will use variables that will display specific information to your terminal. Create the file lab2a.py in your ~/ops435/lab2 directory, containing the following content:

   #!/usr/bin/env python3
   
   name = 'Jon'
   age = 20
   print('Hi ' + name + ', you are ' + str(age) + ' years old.')

3. Try running this script and study the output:

   ./lab2a.py

   This Python script is not very useful: it displays the same output regardless of the number of times that the Python script is run.
   The input() function is used to obtain information from the user and store it into a variable. It is typical to place a question (or hint) as a argument in the input() function: this will aid the user in typing in the correct information.
   
   
4. Replace the print() call in your lab2a.py with the following (you can just comment-out the print() call using a # at the beginning of the line):

   colour = input("Type in a colour and press enter: ")

5. When prompted, type the text: red and press ENTER. Did anything display? Why not?
6. Add another line to your script:

   print(colour)

   What was displayed?
7. Now replace that line with this:

   print('The colour I typed in is: ' + colour)

   Note what was displayed.

Practice Storing User Input

Now it's time to create a new script to prompt the user to enter data and display that data on their terminal. Refer to variable name and prompt text information when creating your Python script. Refer to Sample Runs displayed below for exact prompt and output requirements.

Perform the following Instructions:

1. Make a copy of lab2a.py and call it lab2b.py.
2. Modify lab2b.py so that it prompts the user for both the user's name and age.

Input / Output Requirements

• The script should have a Shebang line
• The script should use a variable called name
• The script should use a variable called age
• The script should prompt the user for "Name: "
• The script should prompt the user for "Age: "
• The script should store the values in the correctly spelled variables (case sensitivity counts)
• The script should print the EXACT OUTPUT as shown (case sensitivity counts)

Sample run 1:

./lab2b.py
Name: Jon
Age: 20
Hi Jon, you are 20 years old.

Sample run 2:

./lab2b.py
Name: Jen
Age: 25
Hi Jen, you are 25 years old.

3. Download the checking script and check your work. Run the following commands from the bash shell.

cd ~/ops435/lab2/
pwd #confirm that you are in the right directory
ls CheckLab2.py || wget https://raw.githubusercontent.com/Seneca-CDOT/ops435/master/LabCheckScripts/CheckLab2.py
python3 ./CheckLab2.py -f -v lab2b

4. Before proceeding, make certain that you identify any and all errors in lab2b.py. When the check script tells you everything is OK, you may procede to the next step.

PART 2 - Arguments

An argument is a value that is passed to a program or passed to a function that can be used for processing within that program or function. In the previous section, you passed an argument to the input() function. In this section, you will learn how to pass an argument to your Python script, but this time, this argument will be passed when we execute your Python script from the bash shell.

Perform the following steps:

1. Use a temporary file for testing your work for this section.
2. In order to read arguments in Python, we will need to import special variables from the system. This is a standard 'library' of code provided by the developers of Python. By issuing import sys, you have loaded code written by another person, each 'library' that gets loaded will give us extra functionality in our program. This is done by issuing the import sys function within your ipython3 shell.
   
   
3. Start with the following line to import special variables:

   import sys

4. Call the following functions and note what they do:

   print(sys.version) # tells us our python version
   print(sys.platform) # tells us our operating system platform
   print(sys.argv) # tells us our arguments or shell version if issued from shell
   sys.exit() # will immediately end the running Python script, ignoring the remaining lines in the Python script

   
   Instead of using the input() function to prompt the user for data, we can use the sys.argv function to store data as a result of running the Python script with arguments. The sys.argv function, when used within your Python script can store the following:
   • sys.argv - stores all argument data
   • sys.argv[0] - stores the name of the script/program
   • sys.argv[1] - stores the first argument
   • sys.argv[2] - stores the second argument
   • etc...
   
   
5. Create a new script called ~/ops435/lab2/showargs.py and add the following content:

   #!/usr/bin/env python3
   
   import sys
   
   arguments = sys.argv
   name = sys.argv[0]
   
   print('Print out ALL script arguments: ', arguments)
   print('Print out the script name: ' + name)

6. Run the script and examine the output by running the Python script without and with arguments:

   ./showargs.py
   ./showargs.py testing different arguments
   ./showargs.py argument1 argument2 argument3

Practice Using Arguments

Now it's time to create a new script, but unlike prompting the user for data, the data (as arguments from running your Python script) will be used instead. Refer to variable name and prompt text information when creating your Python script. Refer to Sample Runs displayed below for exact prompt and output requirements.

Perform the following Instructions:

1. Make a copy of lab2b.py and call it lab2c.py.
2. Modify lab2c.py to use the sys.argv[1] and sys.argv[2] functions instead of the input() function (used in your previous lab2b.py script).

Input / Output Requirements

• The script should have a Shebang line
• The script should contain import sys
• The script should use a variable called name
• The script should use a variable called age
• The script should use sys.argv[1] (first argument)
• The script should use sys.argv[2] (second argument)
• The script should store the values in the correct variables (including case sensitivity)
• The script should print the EXACT OUTPUT as shown (including case sensitivity)

Sample run 1:

./lab2c.py Jon 20
Hi Jon, you are 20 years old.

Sample run 2:

./lab2c.py Jen 25
Hi Jen, you are 25 years old.

Note that running Sample run 3 (shown below) will result in an error message. This error happens if you run the script without any arguments. It is important to note that an error such as this can occur, so you can avoid this type of error when creating Python scripts (explained in the next section). Let's continue in this section for now...

Sample run 3:

./lab2c.py
---------------------------------------------------------------------------
IndexError                                Traceback (most recent call last)

...
...
...

IndexError: list index out of range

3. Download the checking script and check your work. Enter the following commands from the bash shell.

cd ~/ops435/lab2/
pwd #confirm that you are in the right directory
ls CheckLab2.py || wget https://raw.githubusercontent.com/Seneca-CDOT/ops435/master/LabCheckScripts/CheckLab2.py
python3 ./CheckLab2.py -f -v lab2c

4. Before proceeding, make certain that you identify any and all errors in lab2c.py. When the check script tells you everything is OK, you may procede to the next step.

INVESTIGATION 2: USING CONDITIONAL STATEMENTS

In computer programming, control flow statement can be used to change the direction (flow) of a program. The diagram here may help you visualize it. In this section, you will focus on LOGIC control flow statements that are used to change the way each script runs, based entirely on input (either user input, or command arguments). In this section, we will discuss several LOGIC control flow statements including: IF, and IF/ELIF/ELSE.

PART 1 - Using IF Statements

An IF statement is a control flow statement that executes or does not execute different code based on whether the condition is True or False.

Understanding If Statements

Perform the following steps

1. Create a temporary python file for testing things in this section.
2. Let's create an if statement.
   Try the following 2 lines, indenting the second line:

   if True:
       print('This print is apart of the if statement')

   What happened when you ran this code? It is important to note a couple of things with the IF statement:
   • When the condition in an IF statement evaluates to True, it runs the code that is indented underneath it. In this case, we can use the boolean value "True" to make this happen, or test to see if a condition determined true or false.
   • However, if the If condition evaluates to False, then it will not run the code indented underneath it. Any code not indented under the if statement will perform normally as the main program and is NOT associated with control flow statement.
   • Indentation means to start a line with spaces or tabs before your text. Using indentation will direct the script what code will run as part of the IF statement and which code will run regardless. Also, using indentation makes it easier for a programmer to identify Control Flow statements. From this point on, be VERY careful and consistent with indentation because it will affect how your code works.

4 spaces
While python allows some flexibility with your indentation - please don't be creative with it. Always use 4 spaces for each new block. There will be exceptions later on, but start with this now. You may find it helpful to configure your editor to insert for spaces instead of a tab when you press the tab key.

3. Try the following 3 lines, indenting the second and third lines, but NOT the fourth line:

   if False:
       print('This first print statement will never run')
       print('This second print statement will also not run')
   print('This print statement will run')

   What do you notice?
   
   So far, you have been using only the Boolean values True or False for your IF statements. Although this can be useful, it can be more practical to state a condition to test in order to render a True or False Boolean value to be used with control flow statements (referred to as: Boolean Logic).
   
   
4. let's create an IF statement that runs under specific conditions. Issue the following code below:

   password = input('Please enter a secret password')
   if password == 'P@ssw0rd':
       print('You have succesfully used the right password')

   What happened? In the above example, you are making a comparison between the value you entered via the input() function, which in turn, was saved into the password variable. The IF statement is using that variable (called password), followed by == which represents identical to, followed by the string 'P@ssw0rd' . Never use = to 'compare values since this is used to store the value into a variable and may not allow IF statement to properly test the condition! Also note that a space is used to separate arguments with the IF statement. The IF statement tests that condition to see if it is True or False. If that condition is True, it will run the code indented below. On the other hand, if that condition is False, it will not run the code. Try experimenting with different combinations of passwords.
   
   If statements can also be used to compare numbers. We can do this by using comparison operators (such as: ==, !=, >, >=, <, <=), but we can also use functions. The function len() can be used to return the number of characters in a word (plus other features). length of words and other variables. We can also use the len() function to give us the number of argumuents provided to our script by using 'len(sys.argv)' and it should return a number. Below we are also using '!='. Which stands for not eqal to.
   
   
5. Try the following program:

   import sys
   
   print(len(sys.argv))
   
   if len(sys.argv) != 10:
       print('you do not have 10 arguments')
       sys.exit()

   What happened?

Number of Arguments with len(sys.argv)
If you are running the len(sys.argv) function in ipython3, the number of arguments returned will be always be '1'. This number will always be one higher than the actual number of arguments entered, since it also counts the script name as a argument.

Practice Using IF Statements

Now it's time to create a new script. You will be modifying the previous Python script to provide a message if the user did NOT provide any argument when running the script, and abort the script if two additional arguments are not provided. Refer to Sample Runs displayed below for exact prompt and output requirements.

Perform the following Instructions:

1. Make a copy of lab2c.py and call it lab2d.py.
2. Modify lab2d.py by adding an if statement immediately BEFORE your print statements. This if statement should make sure that lab2d.py is using '2' additional arguments.

Input / Output / Processing Requirements

• The script should have a Shebang line
• The script should import sys
• The script should print a usage message if zero arguments present, or if not exactly 2 arguments are provided when running the script
  (NOTE: Use sys.argv[0] value in this message in case you rename the script at a later date!)
• The script should exit without attempting to do any more work if exactly 2 arguments are not provided when running script
• The script should use a variable called name
• The script should use a variable called age
• The script should use sys.argv[1] (first argument)
• The script should use sys.argv[2] (second argument)
• The script should store the values in the correct variables
• The script should print the EXACT OUTPUT as shown

Sample run 1:

./lab2d.py Jon 20
Hi Jon, you are 20 years old.

Sample run 2:

./lab2d.py Jen 25
Hi Jen, you are 25 years old.

Sample run 3:

./lab2d.py 
Usage: ./lab2d.py name age

Sample run 4:

./lab2d.py Jon is 20
Usage: ./lab2d.py name age

3. Download the checking script and check your work. Enter the following commands from the bash shell.

cd ~/ops435/lab2/
pwd #confirm that you are in the right directory
ls CheckLab2.py || wget https://raw.githubusercontent.com/Seneca-CDOT/ops435/master/LabCheckScripts/CheckLab2.py
python3 ./CheckLab2.py -f -v lab2d

4. Before proceeding, make certain that you identify any and all errors in lab2d.py. When the check script tells you everything is OK, you may procede to the next step.

PART 2 - Using IF/ELIF/ELSE Statements

There are many ways to use IF statements in more advanced configurations. This section will provide a few more examples and provide an explanation of how they work.

1. For the following examples, try changing the numbers in the variables to get different results.
2. Create one or more new files for testing the following steps (you won't need to submit them).
3. Let's use an IF statement testing a condition of two variable values. In this case, if variable 'a' is greater than variable 'b', then print a message, if False, do nothing.

   a = 10
   b = 15
   if a > b:
       print('a is greater than b')

   What happened? Let's now use an IF/ELSE statement.
   
   
4. Try the following code instead:

   a = 10
   b = 15
   if a > b:
       print('a is greater than b')
   else:
       print('b is greater than a')

   What happened?
   
   This is neat, but what if 'a' is equal to 'b'? In order to make this work, we would need to perform another test! The 'elif' statement allows us to string together multiple if statement. This new statement 'elif' means: IF the first condition is False, it will check the second condition under 'elif'. HOWEVER, if the first condition is True, it will run the code indented under the first condition and SKIP the 'elif' statement. Finally, we include the ELSE statement - in this case, if 'a' is equal to 'b' (i.e. fails first test since 'a' is not greater than 'b' and fails second test since 'a' is not less than 'b', so they must be equal to check other).
   
   
5. Modify your program to looks like this:

   a = 10
   b = 10
   if a > b:
       print('a is greater than b')
   elif a < b:
       print('b is greater than a')
   else:
       print('a is not greater than b')
       print('a is not less than b')
       print('Therefore, a is equal to b')

INVESTIGATION 3: USING LOOP STATEMENTS

In the first two labs, you have been exposed to tools and methods to write powerful Python scripts. In Lab1, this included using using variables. In Lab 2 you learned how to input variables by either prompting the user for input or using data that are arguments containing within a Python script that you run. You also learned about LOGIC control-flow statements in order to make the Python script behave differently based on differing input.

You will start to learn about the second major category of control flow statements by learning how to repeat a command or a series of commands. Although, you will be learning other scripting techniques, the ability to know how to use variables, CONDITIONAL and LOOPING control-flow statements will allow you to create useful and powerful programs to assist you when managing your computer system (including virtual machines).

PART 1 - Understanding WHILE Loops

WHILE loops use a the same type of conditions found in if statements. While the condition is True, the code indented under the while loop will be repeated. When the condition becomes False the loop will stop repeating.

Perform the following steps

1. Create a temporary python file for practicing with the followin examples.
2. A WHILE loop is not the most common type of loop in Python but it's the simplest. Below is a WHILE loop which will run five times. Each time the loop is run, it will add one to the count variable, increasing the variables number:

   count = 0
   while count != 5:
       print(count)
       count = count + 1
   print('loop has ended')

   Sometimes you know in advance how many times a loop will execute but often you don't. For example loops are extremely useful for error-checking in order to prevent incorrect data being accepted and causing the script not to perform correctly.
   
3. Here is an example of a loop used for error-checking. Run this code and type several incorrect passwords then the correct one to see what happens:

   password = ''
   while password != 'P@ssw0rd':
       password = input("Type in a password: ")
   print('Congratulations you guessed the correct password!')

Now it's time to create a new script. You will be creating an entirely new Python script to use a WHILE loop as a determinant loop. This while loop will count down from 10, print each value as it counts down. When it gets to the end it will output 'blast off!' Refer to Sample Runs displayed below for exact prompt and output requirements.

Perform the following Instructions:

1. Make a new file called lab2e.py, this script will contain a WHILE loop.

Input / Output / Processing Requirements

• The script should have a Shebang line
• The script should use a variable named timer with a value of 10
• The script should have a while loop that repeats until timer equals 0
• The script should print the EXACT OUTPUT as shown

Sample run:

./lab2e.py
10
9
8
7
6
5
4
3
2
1
blast off!

2. Download the check script and check your work. Enter the following commands from the bash shell.

cd ~/ops435/lab2/
pwd #confirm that you are in the right directory
ls CheckLab2.py || wget https://raw.githubusercontent.com/Seneca-CDOT/ops435/master/LabCheckScripts/CheckLab2.py
python3 ./CheckLab2.py -f -v lab2e

3. Before proceeding, make certain that you identify any and all errors in lab2e.py. When the check script tells you everything is OK, you may proceed to the next step.

PART 2 - Using WHILE loops with script arguments

You will now learn to make your Python scripts more flexible by using numbers as arguments to be used with WHILE loops. You will learn that arguments used in Python scripts are strings (not numbers) and therefore, cannot be used in Mathematical operations unless they are converted into numbers (like an integer). You will be learning how to use the int() function in order to convert a string into an integer.

Perform the Following Steps:

1. Make a copy of lab2e.py and call it lab2f.py.
2. Modify lab2f.py to change the initial value of the variable count to the first argument when running your Python script. WARNING: When using arguments as numbers/integers or performing math on arguments you must wrap them in the int() function, for example: count = int(sys.argv[1])

Additional Input / Output / Processing Requirements

• The script should have a Shebang line
• The script should import sys
• The script should use a variable named timer with the value of int(sys.argv[1])
• The script should have a while loop that repeats until timer equals 0
• The script should print the EXACT OUTPUT as shown

Sample run 1:

./lab2f.py 10
10
9
8
7
6
5
4
3
2
1
blast off!

Sample run 2:

./lab2f.py 3
3
2
1
blast off!

3. Download the check script and check your work. Enter the following commands from the bash shell.

cd ~/ops435/lab2/
pwd #confirm that you are in the right directory
ls CheckLab2.py || wget https://raw.githubusercontent.com/Seneca-CDOT/ops435/master/LabCheckScripts/CheckLab2.py
python3 ./CheckLab2.py -f -v lab2f

4. Before proceeding, make certain that you identify any and all errors in lab2d.py. When the check script tells you everything is OK, you may proceed to the next step.

PART 3 - Combining WHILE loops with IF statements

Let's improve upon your previous shell script to further prevent errors from incorrect input. You can combine LOGIC control-flow statements with other LOGIC control-flow statements for more complex programming. For example, if you ran the previous Python script without an argument (i.e. empty string), you would encounter an error since it could not convert an empty string to an integer.

Perform the Following Steps

1. Make a copy of lab2f.py and call it lab2g.py.
2. Modify lab2g.py, add an IF statement to the script that checks to see if a argument was entered. If a argument was entered use that number for the timer, if no argument was entered, then by default, the timer should equal 3.

ADDITIONAL WARNINGS
When using arguments as numbers/integers or performing math on arguments you must wrap them in the int() function:

timer = int(sys.argv[1])

Remember to check the number of arguments in an IF statement using:

len(sys.argv)

Additional Input / Output / Processing Requirements

• The script should have a Shebang line
• The script should import sys
• The script should use a variable named timer with the value of 3 if no arguments are entered
• The script should use a variable named timer with the value of int(sys.argv[1]) if arguments are entered
• The script should have a WHILE loop that repeats until (and not including when) timer equals 0
• The script should print the EXACT OUTPUT as shown

Sample run 1:

./lab2g.py 5
5
4
3
2
1
blast off!

Sample run 2:

./lab2g.py 2
2
1
blast off!

Sample run 3:

./lab2g.py
3
2
1
blast off!

3. Download the check script and check your work. Enter the following commands from the bash shell.

cd ~/ops435/lab2/
pwd #confirm that you are in the right directory
ls CheckLab2.py || wget https://raw.githubusercontent.com/Seneca-CDOT/ops435/master/LabCheckScripts/CheckLab2.py
python3 ./CheckLab2.py -f -v lab2g

4. Before proceeding, make certain that you identify any and all errors in ab2f.py. When the check script tells you everything is OK, you may proceed to the next step.

LAB 2 SIGN-OFF (SHOW INSTRUCTOR)

Students should be prepared with all required commands (system information) displayed in a terminal (or multiple terminals) prior to calling the instructor for signoff.

Have Ready to Show Your Instructor:

✓ Output of: ./CheckLab2.py -f -v

✓ Output of: cat lab2a.py lab2b.py lab2c.py lab2d.py lab2e.py lab2f.py lab2g.py

Be able to answer any questions about the lab to show that you understood it!

LAB REVIEW

1. Write a Python function to input the user for their shoe size, and store the result in a variable called shoeSize.
2. Write a Python function to display the shoe size entered from using the value stored in the variable mentioned in the previous question. (For example: Your size size is: 16).
3. What is the purpose of importing special variables from your system?
4. Write a function to display two arguments from running your Python script.
   For example if your Python script was called myscript.py and you issued the command:
   python myscript.py happy afternoon, you would get the following output:
   
   The first argument is: happy
   The second argument is afternoon
   
   
5. What is the purpose of using an if statement?
6. What is the purpose of using an if-else statement?
7. Write Python code to terminate the execution of the running Python script if there not exactly 3 arguments contained after the Python script upon execution.
8. What is the purpose of an if-elif-else statement?
9. Write a Python script to prompt the user for a course mark (no error checking is required... you can assume that the input will be a valid mark from 0 to 100). Use an if-elif-else statement to convert the mark to a letter grade. For simplicity, you don't have to worry about D+, C+, B+, or A+
10. Write a Python script to print the text I love Python twenty times (on a separate line).
11. INTERESTING CHALLENGE: Perform a Netsearch to see how you can write Python code to perform error-checking (using a loop) to force a user to enter a number for the shoe size script (created in question #2). There are two things to consider:
    1. A number as opposed to a string
    2. It has to be an acceptable range from 1 to 20