Open main menu

CDOT Wiki β

OPS435 Python Lab 1

Revision as of 10:06, 1 August 2017 by Andrew (talk | contribs) (Using Magic Functions)

LAB OBJECTIVES

In advance of this lab, you will install a current distribution of Linux to be used as a host machine. You will NOT be required to setup Virtual Machines for this lab (that will be covered in a future lab). You will then setup your Python scripting environment on your host machine, including the setup the of python libraries and also the setup of a user-friendly interactive Python environment called ipython. You will also install additional framework tools (such as git, vim, and tmux) to be used in later labs.
After selecting an appropriate text editor to use, then you will start to create Python scripts to learn basic operations such as: printing text, using variables, and performing math operations.



INVESTIGATION 1: INSTALLING LINUX VM

PART 1 - Installing Your Linux Distribution

Centos 7 - release 1161 will be used for this course. The purpose for this is to allow you to use a consistent and stable RedHat based OS, and to lower the amount of new linux distros that you need to learn.
Most of you will likely use the school's Windows machines with the Vmware hypervisor. It is also possible to use your own computer, but check with your professor before you do that.
Centos 7 comes with python 2.7, for this course we will be primarily using Python3. However, not practicing python 2.7 would be a mistake, since so many programs and operating systems still depend on Python2. It is recommended that students note general improvements/differences in Python2 and Python3.


Centos 7 VM Details / Minimum Requirements:
  • Name: centos7
  • Boot media / Installation: CentOS7 Full Install DVD
  • Disk space: 50GB
  • CPUs: 4
  • Internal Memory: 8GB


Perform the following steps:
  1. Regardless of the Linux distribution that is used for this course, these lab will be using and referring to the current version of Centos7 (Graphical Desktop) for our main Linux machine. When creating your VM, refer to the Details / Minimum Requirements section above for assistance.
  2. Install Centos7 VM selecting the default partitions. When you have finished the installation of Centos7, you may proceed to the next step.
Unit Evaluation Scripts
Each Part (within an 'Investigation) is referred to as a Unit. Each Unit will require that the student download and run a Unit Evaluation Script, which provides the OPS435 student "real-time feedback" of their completed work.
This feedback is not considered to be perfect or fool-proof; however, it may provide feedback (hints) in case a student gets stuck or experiences an error when performing administration tasks or when creating their Python scripts. These unit evaluation scripts can also be used to confirm that the student's Python script is on the right track, and provide a consistent record of their Python scripting progress throughout their labs.
  1. Issue the following commands (as a regular user) in order to setup, download and run the first unit evaluation script:
    mkdir -p ~/ops435/lab1/
    cd ~/ops435/lab1/
    pwd  #   <-- i.e. confirm that you are in the correct directory
    ls CheckLab1.py || wget matrix.senecac.on.ca/~acoatley-willis/CheckLab1.py
    python3 ./CheckLab1.py -f -v lab0a
  2. Before moving on to the next step make sure you identify any and all errors from the check script.
    When the check script tells you everything is "ok" for "lab0a", you may proceed to the next step.

  3. Make notes for all of your Investigation 1 (part1) observations in your lab log book, and proceed to part 2.

PART 2 - Setting up Your Python Environment For Labs

In order to learn how to use python on your Linux machine, it is important to setup your Linux environment and learn how to interact with a Python shell.


Perform the following steps:
  1. The first step is to update your entire system.
    yum update
  2. Install extra packages for enterprise linux:
    yum install epel-release
  3. Next install applications that we required, first Python version 3 and version 2:
    yum install python34 python34-devel # Install python3.4 and python3.4 development libraries
    yum install python python2-devel # Install python2.7 and python2.7 development libraries
  4. Next, you will install a couple of useful applications called tmux and screen. They are referred to as terminal multiplexers. If you plan to spend a lot of time in the terminal, this powerful tool will help you get it done. Lets install it and plan to use it later:
    yum install screen tmux && ln -s /usr/bin/true /etc/sysconfig/bash-prompt-screen
  5. Set your hostname to the Linux Distribution we are using in case you did not set it correctly during the install process:
    hostnamectl set-hostname centos7 # Set your hostname to distribution-name
You will be required to use a text editor in order to create and modify your Python scripts. There are many text editors that provide various features to become more comfortable and productive during your Python coding sessions.
Below is a listing of several common text editors and their features.
Selecting an Appropriate Text Editor

Vim (recommended text editor for labs)
vim is a powerful text editor for system administration and programming tasks. All of the shortcuts and commands you've learned over the years will help you edit programs efficiently.
Geany
A simple graphical text editor for developers. It is available in the CentOS package repositories.
Atom
This text editor is easy to use and contains powerful tools that comes with everything needed to program and customize the environment.

Sublime
Another powerful and popular text editor designed for programming. Is not open source.
  1. Python pip is a package manager specifically for Python. While it is usually not recommended to install software outside of dnf or yum, sometimes the only way to get a specific or latest version will be through pip:
    yum install python-pip # Install python2.7 pip
    yum install python34-pip # Install python3.4 pip
  2. Issue the following command to install git:
    yum install git # Install git command line tool
What is a Git?
Git refers to a version control system that allows you to track any changes made to files and programs. Our primary use for git in this course will be for backup onto to the internet. Check out bitbucket for a free private code repository.
  1. IPython will be one of the tools we will use the most. Lets install it. You will learn more about it in the next section:
    yum install python-ipython # Install ipython for python2.7
    pip3.4 install ipython  # Install ipython for python3.4
  2. Issue the following commands in your shell to check your work for this section:
    cd ~/ops435/lab1/
    pwd #confirm that you are in the right directory
    ls CheckLab1.py || wget matrix.senecac.on.ca/~acoatley-willis/CheckLab1.py
    python3 ./CheckLab1.py -f -v lab0b
  3. Before moving on to the next step, make sure you identify and correct any and all errors in "lab0b" output. When the check script tells you everything is "ok", you may proceed to the next step.
  4. Make notes for all of your Investigation 1 (part2) observations in your lab log book, and proceed to investigation 2.



INVESTIGATION 2: USING THE "IPYTHON" CLI

IPython is an interactive environment that allows us to run python code line by line as we write it. This will also act like a bash shell prompt allowing users to enter a limited number of Bash shell commands. You will notice this by seeing an [IN] prompt where to enter commands and an [OUT] prompt that will display output from issued commands. We will start creating scripts out of the code within this IPython environment.

PART 1 - Common Ipython Commands and Features

Using Magic Functions

Lets begin by running some python code in the ipython interactive shell. This is a advanced python shell, similar to the bash shell that you have been using throughout the Linux courses. Throughout these labs the term command can also refer to these "magical functions".
Perform the following steps:
  1. To access the ipython shell, issue the following command:
    ipython3
    Now we are now inside the IPython environment. We can run some basic bash commands within this shell by issuing IPython magic functions.
  2. Lets try a few commands out now:
     ls
     pwd
     cd ~/
     ls
    Remember: You are not using Python here, instead, these are aliases for Bash shell commands that IPython gives you access to. What you are actually using is bash, but not all bash commands are available in the IPython environment.

  3. Lets find out which ones are available, type the following command into the IPython shell:
     alias
    We should now have a list of all the bash commands available in IPython. Shortly, we will go over how to add new bash commands into this environment, but you must remember that these commands are only here to assist in your python scripting - we are NOT here to learn bash commands.

  4. Next lets add a new bash command that seems to be missing from this list:
     alias vim vim
  5. Run the vim command to see that it works, then exit your vim editing session without saving.
  6. The vim command will give us our much needed syntax highlighting, while we are editing scripts from within the IPython environment. Unfortunately, these magic alias functions do not save in between sessions when defined temporarily, this creates a problem since you would have to create them every time you start IPython. It will instead display an error message indicating that the alias command does not exist:
     exit
     ipython3
     vim
    You should notice an error message indicating invalid syntax. This occurs since you need to create a config file to make this alias persist in-between sessions. You need to exit your ipython session in order to edit this configuration file.

  7. Exit your current IPython session:
     exit
  8. Now, create a new ipython alias configuration file and add the following content to it:
     vim ~/.ipython/profile_default/startup/00-alias.ipy
  9. Place your newly defined alias inside this file:
     %alias vim vim
  10. Save and exit the file. Now let's return to our IPython shell and confirm that our alias is available right away:
     ipython3
     vim

    At this point vim should open successfully and you should now understand how to create new IPython aliases and store them persistently. Use these aliases to customize your environment with any bash commands you thing IPython is missing.

  11. Exit vim and return to the IPython shell.

  12. Lets setup a directory structures for completing and organizing labs. These should be the locations to store your lab scripts. Try using TAB to help speed up the issuing of the following commands:
     mkdir ~/ops435/lab2
     mkdir ~/ops435/lab3
     mkdir ~/ops435/lab4
     mkdir ~/ops435/lab5
     mkdir ~/ops435/lab6
     mkdir ~/ops435/lab7
     mkdir ~/ops435/lab8
  13. If you are interested in finding more information about other magic functions in IPython, then within the IPython shell, and enter the following (press the letter q to exit this function):
     magic
This resource will appear OVERWHELMING (a huge amount of information)! As we move throughout this course, you will slowly use different magic functions from here, but we will never use all of them. They cover a huge range of different tasks, while we are writing code, allowing us to interactively inspect the Python we are writing and running. Lets move on for now.
  1. Issue the following command to exit your ipython session:
     exit
  2. In the future see if ctrl-d works instead of issuing the exit command to quit the ipython shell.
  3. Perform the following steps to evaluate this unit. Run these check scripts regularly as you work through the labs, they may give you hints if you get stuck.
  4. cd ~/ops435/lab1/
    pwd #confirm that you are in the right directory
    ls CheckLab1.py || wget matrix.senecac.on.ca/~acoatley-willis/CheckLab1.py
    python3 ./CheckLab1.py -f -v lab0c
  5. Make notes for observations in your lab log book, and proceed to investigation 3.



INVESTIGATION 3: WRITING PYTHON SCRIPTS

In this investigation we will start writing our very first python scripts. These will be very basic and help us practice syntax and foundation skills, such as: outputting text to the screen, storing data inside variables, and using math operators.

PART 1 - Common Introductory Python Functions

Printing Text

Let's start IPython interpreter and start writing some python code.
Perform the following steps:
  1. Issue the following commands:
     ipython3
     cd ~/ops435/lab1
     pwd
     ls
    Our first python code we will write is going to call the print function. A function is code that has been defined in another location. Functions can take arguments, use these arguments in some way, and then usually return a result. The first function we will use is the "print()" functions, it's sole purpose is to output information to the screen.

  2. At the prompt, execut the following:
    print()
    You will notice that nothing happened when we ran this "print()" function. This is because we didn't pass any arguments to it, lets try again.

  3. Issue the following function:
    print('hello world')
    This time we should now see that the python function "print()" has outputted to the screen the words 'hello world'. In python a word or a bunch of characters like 'hello world' is called a 'string'. So what we did above is, passed a string as a argument to the print function. These words are important for understanding and talking about different aspects of code.

  4. Note that there are similarities between the Python print() function and the Bash echo command, but Python is more picky than bash (which is a good thing). Try to run print without the brackets or without the quotes to see what happens.
Reading errors
One of the things that makes a good programmer is debugging skills. The first and most important debugging technique is reading and understanding error messages. Try to understand what the errors are saying even if you think you already know what the problem is and already have some idea about how to fix it.

Creating the introductory "Hello World" Script

You will learn to create a simple python script in this section. This python script will just print the text "hello world". The "hello world" an old traditional first program students usually are taught to create, which is based on the first programming example from the first C programming text co-written by Dennis Ritchie, the creator of the C programming language and Brian Kernighan. You will learn how to run the python script in the ipython3 shell as well as learn how to run the python script from the bash shell.

Perform the following steps:
  1. Using a text editor, open a new text file called lab1a.py:
    vim ~/ops435/lab1/lab1a.py
  2. Write the following code into our python file. Note the she-bang line at the top of the file to run this script in the python3 environment. You will need to add this she-bang line for all python scripts you create for this course.
    #!/usr/bin/env python3
    
    # Any line that starts with a "#" is also known as a comment,
    # these lines are ignored by the python interpreter even if
    # they contain code. The very first line is called a Shebang line, 
    # it is used to tell the system which interpreter to 
    # use(python2, python3, bash, etc). 
    
    # Description: This program will output "hello world" to the screen
    
    print('Hello world')
  3. Save the file and quit vim. We will now go over the process of manually running this python script. Both in the Bash shell and in the IPython shell.
  4. Now lets try running the script directly from the IPython shell by issuing the follwoing commands:
    run ~/ops435/lab1/lab1a.py
    Your python script should have run, if you have any errors you should check that you typed the script in exactly. Be careful of extra spaces, symbols, letters, or lowercase/uppercase differences.

  5. Issue the following command to exit your ipython session:
    exit
  6. Now, from the Bash shell we will give it the correct Linux permissions in order to run your newly-created python script. This is just showing the multiple ways you can use this python script. You are not required to have IPython running on a system, however hopefully we can use IPython's powerful features to our advantage.
  7. Run your python script by issuing the following commands:
    chmod 755 ~/ops435/lab1/lab1a.py
    python3 ~/ops435/lab1/lab1a.py
  8. Download the check script and check your work. Enter the following commands from the bash shell.
     cd ~/ops435/lab1/
     pwd #confirm that you are in the right directory
     ls lab1a.py #confirm that you have the lab1a.py script in your directory
     ls CheckLab1.py || wget matrix.senecac.on.ca/~acoatley-willis/CheckLab1.py
     python3 ./CheckLab1.py -f -v lab1a
  9. Before moving on to the next step make sure you identify any and all errors in "lab1a.py". When the check script tells you everything is "ok", you may proceed to the next step.
  10. Make notes for observations in your lab log book, and proceed to part 2.

PART 2 - Working with Variables

A variable is used to store data for use later in the program. This data can be a string, integer, decimal number, characters, etc. We will only be covering string and integer variables in this lab. You will learn and use other variable types in future labs.

String Variables

String variables contain text to be used in your program. Examples of strings could be user-names, full-names, item descriptions, etc. We will now demonstrate to assign a string to a variable and how to display string variables.
Perform the following steps:
  1. First, launch the ipython3 shell:
    ipython3
  2. Let's make a new variable containing a value by issuing the following command:
    name =  'Thomas'
  3. Type the variable name to inspect the value it contains
    name
  4. Print the value to the screen:
    print(name)
  5. Think about why this does something different:
    print('name')
  6. Now lets try something new, we are going to print out the string and concatenate/combine it with another string. The plus sign can be used to join 2 strings together. However, make sure that your variable is always outside the quotes, or it will not resolve to a value.
    print('I have a friend named ' + name)
  7. To gain practice, create a python script (called lab1b.py) with the following content and details:
  • The script should have a Shebang line like you did for your lab1a.py python script
  • The script should use a single variable called "name"
  • The value of the "name" variable should be "Isaac"
  • The script, when executed, should print out "How old are you Isaac?"
  • Sample run:
     cd ~/ops435/lab1/
     run ./lab1b.py
     How old are you Isaac?
    Try the checking script as you are working through a script to sometimes get hints.

  1. Download and run the checking script. Enter the following commands from the bash shell:
    cd ~/ops435/lab1/
    pwd #confirm that you are in the right directory
    ls CheckLab1.py || wget matrix.senecac.on.ca/~acoatley-willis/CheckLab1.py
    python3 ./CheckLab1.py -f -v lab1b
  2. Before proceeding, make certain that you identify any and all errors in "lab1b.py". When the check script tells you everything is "ok", you may procede to the next step.

Integer Variables

Integer variables are used to store a integer numbers that can be used for mathematical operations (discussed in the next section). Integers do NOT contain decimals, and they can be signed (+ or -) or unsigned. Here we will store integers in a variable, perform math operations, and display the results.
Perform the following steps:
  1. Enter the following command to access the python prompt:
    ipython3
  2. Lets create some new variables to play with.
    num1 = 5
    num2 = 10

    In IPython we can inspect these variables by just typing the name of the variable. But in a python script this will not provide any output. This feature is useful however for debugging.

  3. Issue the following commands:
    num1
    num2
  4. Now we will make a new variable and try some math:
    sum = num1 + num2

    This will add the values contained in the variables together, providing a sum. However you will note that there is no output. First lets inspect the new value.

  5. Enter the following command:
    sum

    Does this value look right? Are you sure? If we wanted to print this out to the screen we could use the following python code.

  6. Enter the following function:
    print(sum)
  7. Now lets try printing this sum out with a string:
    print('The sum is: ' + sum)

    What happened? Did you receive an error? This will may have been the first time you've seen this error, but it won't be the last. What we tried to do is combine a string with a number, and this won't work.

    In order to use display this number as a string we will use the "str()" function on it. The "str()" function will return a string of your number and provide it as a argument to "print()". This function will not change the value of your variable, your variable is still a interger.

  8. Issue the following:
    print('The sum is: ' + str(sum))

    What did you notice this time?
  9. To gain practice, create a python script (called lab1c.py) with the following content and details:
  • The script should have a Shebang line.
  • The script should have a variable called name
  • The script should have a variable called age
  • The value of the name variable should be Isaac
  • The variable age should contain a integer
  • The value of the age variable should be 72
  • The script, when executed, should print out "Isaac is 72 years old!"
Example run:
cd ~/ops435/lab1/
run ./lab1c.py
Isaac is 72 years old!

Try the check script as you are working through a script to sometimes get hints.
  1. Download and run the checking script. Enter the following commands from the bash shell:
    cd ~/ops435/lab1/
    pwd #confirm that you are in the right directory
    ls CheckLab1.py || wget matrix.senecac.on.ca/~acoatley-willis/CheckLab1.py
    python3 ./CheckLab1.py -f -v lab1c
  2. Before moving on to the next step make sure you identify any and all errors in "lab1c.py". When the check script tells you everything is "ok", you may procede to the next step.
  3. Make notes for observations in your lab log book, and proceed to part 5.

PART 5 - MATH OPERATORS

In the previous section, you performed a couple of simple mathematical operations. In this section, you will learn some additional mathematical operations.
Perform the following steps:
  1. Issue the following commands to see how they operate in the ipython shell:
    10 + 5    # addition
    10 - 5    # subtraction
    10 * 5    # multiplication
    10 / 5    # division
    10 ** 5   # exponents
    NOTE: You must be careful when combining more complex math operators together. Python uses PEMDAS (Parentheses, Exponents, Multiplication and Division, Addition and Subtraction) to resolve math.

  2. Go over the below examples and see if you understand each situation:
    10 + 5 * 2		# multiplication happens before addition
    (10 + 5) * 2 		# parentheses happen before multiplication
    10 + 5 * 2 - 10 ** 2	# first exponents, then multiplication, then addition and subtraction from left-to-right
    15 / 3 * 4		# division and multiplication happen from left-to-right
    100 / ((5 + 5) * 2)	# the inner most parentheses are first performing addition, then parentheses again with multiplication, finally the division
  3. To gain practice, create a python script (called lab1d.py) with the following content and details:
  • The script should have a Shebang line.
  • The variable x should contain a integer with the value 10
  • The variable y should contain a integer with the value 2
  • The variable z should contain a integer with the value 5
  • The script, when executed, should print out "10 + 2 * 5 = 20"
Example run:
cd ~/ops435/lab1/
run ./lab1d.py
10 + 2 * 5 = 20
Try the checking script as you are working through a script to sometimes get hints.

  1. Download and run the checking script. Enter the following commands from the bash shell:
    cd ~/ops435/lab1/
    pwd #confirm that you are in the right directory
    ls CheckLab1.py || wget matrix.senecac.on.ca/~acoatley-willis/CheckLab1.py
    python3 ./CheckLab1.py -f -v lab1d
    Before moving on to the next step make sure you identify any and all errors in "lab1d.py".

  2. When the check script tells you everything is "ok", you may proceed to the next step.

  3. Make notes for observations in your lab log book, and proceed to Lab 1 Instructor Sign-off.



LAB 1 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: ./CheckLab1.py -f -v
Output of: cat lab1a.py lab1b.py lab1c.py lab1d.py
Be able to answer any questions about the lab to show that you understood it



Extra topics

  1. x
  2. x
  3. x