Python

From CSE330 Wiki
Revision as of 06:10, 10 January 2023 by Zach (talk | contribs) (→‎Python Script Files)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Languages like Java and C++ have lots of rules regarding variable types, syntax, return values, and so on. These can be cumbersome when you are trying to write short, quick scripts to perform tasks. This is where a scripting language comes into play.

Python is a language well-suited to rapid prototype development. It is generally an interpreted language, which means that, generally speaking, a Python program is converted line by line into instructions for the computer to execute as the program runs, instead of having a separate compilation step beforehand [1]. The syntax is clean, and it is usually clear at first glance what is going on when you write in Python.

Installation

Python may already be installed on your system. To see whether or not it is, enter the command

$ python3 --version

If it tells you a version of Python greater than or equal to 3.6 then you're good to go. If not, you need to do a quick package install to get it up and running. Using yum, it's just sudo yum install python36.

If you'd like to be able to just type python instead of python3, you can add the following line to the ~/.bashrc file on your instance:

alias python="/usr/bin/python3"

Python 2 vs Python 3

In 2008, a new version of Python – Python 3 – was released, with a number of changes that made it incompatible with the previous version, Python 2. For several years, the Python community was slow to make the change to Python 3, but today, Python 3 is the standard for new code. The only reason to write Python 2 code today is because you have to work in an environment or with libraries that do not support Python 3, and that situation is becoming increasingly rare.

For CSE 330 (and this guide), you must use Python 3.6 or greater.

Pip

Linux distributions have package managers like Apt, Yum, and YaST. PHP has a package manager named PEAR. It's now time to introduce Python's leading package manager: pip.

Once you have pip installed, you can use it to install Python packages. Use the pip-3.6 command:

$ pip-3.6 install <package_name> # RHEL


If you'd like to be able to just type pip instead of pip-3.6, you can add the following line to the ~/.bashrc file on your instance:

alias pip="/usr/bin/pip-3.6"

Running Python

There are two common ways to run Python code: via the console, and via a Python script file.

The Python Console

The Python console enables you to experiment with code without opening a text editor. To enter the Python console, simply type the python command at the terminal:

$ python3

To leave the interactive console, either type quit() or press Ctrl-D (on both Mac and Windows).

Python Script Files

You can also save Python script files for later use. The extension for Python scripts is *.py. To run a script file, simply feed its path as an argument to the python command in Terminal:

$ python3 <my_script>.py

Python Syntax and Language Components

This section contains a very brief overview of Python syntax. For a more comprehensive introduction, see the Python docs.

Python's Type System

Python is a dynamically-typed, strongly-typed, and duck-typed language. What does that mean? Well, let's take those categories one by one:

  1. Dynamic typing, in contrast to static typing means that the types of objects can be changed. In Java, for instance, if you tried to write the following code:
    int c = 2;
    c = "fish";
    

    Your code would fail to compile, because the Java compiler wouldn't allow you to change the type of the variable c from int to String.

    Python, however, is just fine with that. You can write:

    c = 2
    c = "fish"
    

    And Python will happily do what you ask.

  2. Strong typing, in contrast to weak typing, means, roughly, that a language won't implicitly convert types for you. So far, you've used a lot of PHP, which is very weakly typed. For example:
    echo "10" . 2;
    

    In PHP, this works just fine. The PHP interpreter sees that 2 is an int, and silently converts it to a string for you, so that "10". 2 equals "102". The problem with weak typing is that it can make it unclear to the programmer why things are happening the way they are. For instance, in PHP, the expression "10" == 10 is true, which can be less than obvious. Python, however, tries to disallow that sort of thing:

    "10" + "10" # Allowed – concatenates the two strings.
    10   +  10  # Allowed – adds the two ints.
    "10" +  10  # Not allowed – raises a TypeError
    

    Perhaps the one exception to this rule is the relationship between numeric types; it's perfectly fine to add a float to an int, for example.

  3. Duck-typing is a little bit different than the other categories, because it doesn't really have a direct opposite. Essentially, duck-typing is the philosophy that "If it walks like a duck, and quacks like a duck, it's a duck." In programming terms, that means that we often don't care what type an object is, as long as it can do the things we ask. Let's look at an example:
    # This function doubles the value it's passed.
    def double(thing):
        return thing + thing
    double(10) # Returns 20
    double("fish") # Returns "fishfish";
    

    If this were Java, we'd have to write two different methods here: one for things of type int, and one for things of type String. Since this is Python, though, we don't have to do that. Instead, Python lets us say, essentially: "This function uses the + operator, so you can pass whatever object you want to the function, as long as the function supports the + operator".

    To quote Alex Martelli, one of the key people in the Python project,

    "[Don't] check whether it IS-a duck: check whether it QUACKS-like-a duck, WALKS-like-a duck, etc, etc, depending on exactly what subset of duck-like behaviour you need."

Basic Types

In Python, the basic scalar types are:

  1. str – a string.
  2. int – an integer object with unlimited digits.
  3. bool – a Boolean value.
  4. float – a floating point number; generally equivalent to double in Java.
  5. bytes – represents a collection of bytes; you're unlikely to use this often.

Casting is done in the C style - to parse an int from a string, for instance, you'd write int("123").

Basic Control Flow

In Python, blocks of code are delineated using colons and indentation instead of curly braces. That means that proper indentation is mandatory. Every time you use a colon, you must indent one step further, and every time a block ends, you must unindent a step.

Conditional statements are done using the if, elif, and else operators, like in the example below - pay attention to the indentation:

cookies_left = 10
cake_slices_left = 3
if cookies_left > 10:
    print("Lots of cookies!")
elif cookies_left > 8:
    print("Plenty left!")
elif cookies_left == 5:
    print("Halfway done!")
else:
    if cake_slices_left == 3:
        print("Lots of cake!")
    elif cake_slices_left == 2:
        print("One slice gone!")
    else:
        print("Little to no cake left!")

An Example Python Script

In my mind, there's no better way to learn Python than to be immersed in a simple example script.

print("Hello World")

fruits = ["apple", "banana", "cherry", "date"]
for fruit in fruits:
    print(f"I always love to eat a fresh {fruit}")

# Map the fruits list over to a new list containing the length of the fruit strings:
fruit_size = [len(fruit) for fruit in fruits]

avg_fruit_size = sum(fruit_size) / len(fruit_size)
print(f"The average fruit string length is {avg_fruit_size:.2f}.")

Some things to notice:

  • Printing is achieved using the print() function.
  • Comments start with a pound symbol #.
  • We can transform/map a list to a new list in just one line!

For some more examples, see the Python wiki.

A Few Gotchas

Here are a few things you may not expect when starting out with Python:

  1. Strings can be delimited using either single quotes (') or double quotes ("), so 'Python' is the same as "Python". You can also use three sets of quotes (single or double again) to delineate a multiple-line string, like so:
    long_string = """This
    is my
    very long
    multiple-line
    string"""
    
  2. To compare the equality of two objects, use the == operator. To compare the identity of two objects (i.e. whether or not they are literally the same object, at the same place in memory), use the is operator. These correspond, respectively to .equals() and == in Java.
  3. The / operator performs floating-point division, not integer division, even when both its arguments are integers. If you want to do integer division, use the // operator. Let's look at an example:
    9   / 10    == 0.9 # Floating-point division
    9.0 / 10.0  == 0.9 # Floating-point division
    9   // 10   == 0   # Integer division
    9.0 // 10.0 == 0.0 # Integer division, even though the resulting value is a float
    
  4. As discussed in the section Python's Type System, you can't combine strings and numbers using the + operator. Instead, you'll have to use one of the following methods of string formatting:
      
    # Technique 1 – printf-style Formatting
    # This is a classic style of string formatting, used in many programming languages, including in Java's String.format.
    "You scored %d out of %d!" % (score, questions)
    
    # Technique 2 – str.format
    "You scored {} out of {}!".format(score, questions)
    
    # Technique 3 – f-strings
    # These were only introduced in Python 3.6 but they're very convenient.
    f"You scored {score} out of {questions}!"
    
    # Technique 4 - String Concatenation
    # This is fine for small things, but for more complicated stuff, use one of the other techniques.
    "You scored " + str(score) + " out of " + str(questions) + "!"
    

Functions

Define functions using the def keyword:

def hello(name):
    print(f"Hello, {name}!")

Invoke functions using parentheses:

hello("Batman")
hello("Superman")

Functions can have optional arguments; however, these must come after any required arguments:

def hello(name="User"):
    print(f"Hello, {name}!")

hello() # Prints "Hello, User!"
hello("Sarah") # Prints "Hello, Sarah!"

Functions are just regular objects in Python, meaning you can do stuff like this:

def hello(name="User"):
    print(f"Hello, {name}!")

greeting = hello

greeting("Siwei") # Prints "Hello, Siwei!"

Collection Types

Python has a few basic, built-in collection types. They each have their own special use cases, but they share a lot of similarities. All built-in data structures in Python are zero-indexed, for instance.

To obtain the number of elements in a collection, use the len() function, like this:

pets = ['Dog', 'Cat', 'Fish'] # This is a list; you'll learn about them below.

len(pets) # Returns 3

To check if a collection contains an item, use the in operator:

pets = ['Dog', 'Cat', 'Fish'] # This is a list; you'll learn about them below.

'Dog' in pets # Returns True

Helpfully, the Python Software Foundation maintains a page containing the asymptotic complexities of important operations on major Python data structures. It's available here.

Lists

Unlike languages like Java and C, Python's array-like type doesn't have fixed length. Instead, a list is a dynamic array (like Java's ArrayList) of objects of any type. Here's an example:

fruits = ["Apple", "Pear", "Orange"] # Lists can be creating by placing their items between square brackets

random_items = ['Apple', 12312, 2.0, [1, 2, 3]] # Lists can contain objects of different types - even other lists!

pets.append('Turtle') # Adds 'Turtle' to the end of pets

For the next few examples, we'll be using the following list:

pets = ['Dog', 'Cat', 'Fish', 'Turtle', 'Lizard', 'Snake']

To access or assign elements of a list, use the [] operator.

pets[0] # Returns 'Dog'
pets[1] = 'Cow' # Sets pets[1] to 'Cow'
pets[1] = 'Cat' # Sets pets[1] back to 'Cat'

You can also access or assign lists using negative indices, which will return elements starting from the end of the list:

pets[-1] # Returns 'Snake'
pets[-2] # Returns 'Lizard'

You can also use 'slice notation' to obtain or assign subsets of lists:

pets[start:end] # Returns items from index start to index end - 1.
pets[start:]    # Returns items from index start to the end of the list, inclusive.
pets[:end]      # Returns items from the beginning of the list to index end - 1.
pets[:]         # Returns every item in the list

There's also a third, optional argument: step, which lets you jump over values:

pets[start:end:step] # Returns items from index start to index end - 1, jumping step values at a time

# Examples:
pets[1:5:2] # Returns items from index 1 to index 4, jumping 2 at a time, so ['Cat', 'Turtle']
pets[::3] # Returns all items in the list, jumping 3 at a time, so ['Dog', 'Turtle']
pets[::-1] # Returns all items in the list, jumping -1 at a time. This reverses the list, so ['Snake', 'Lizard', 'Turtle', 'Fish', 'Cat', 'Dog']

Lists have all the performance characteristics you'd expect of a dynamic array - constant-time indexing, amortized constant-time appends, and so on.

Tuples

Python has a special data type called tuple, which is exactly the same as a list except for the fact that it cannot be modified, so you can't append or replace items.

cities = ('St. Louis', 'Los Angeles', 'Seattle') # Tuples are defined using parentheses.
numbers = 1, 2, 3 # You can also omit the parentheses if it's unambiguous
single_item_tuple = (1,) # To make a tuple with only one item, put a comma after it

Tuples also enable you to have multiple return values from a function:

def compute_length(string):
    str_len = len(string)
    if str_len < 5:
        return str_len, "short"
    elif str_len < 40:
        return str_len, "medium"
    return str_len, "long"

length, description = compute_length("Four score and seven years ago")
print(f"The {description} string is {length} characters long.")

The above example also demonstrates Python's if...elif...else conditional structure.

Dictionaries

Python has another datatype called a dictionary (or dict, for short), which are like Maps in Java, associative arrays in PHP, and object literals in JavaScript (coming up soon in Module 6). Essentially, they enable you to use any immutable object as the key in your data structure. dict objects can be created using either the dict function, or by placing items between curly braces, separating keys and values using colons:

fruits_in_bowl = {
    'apple': 4,
    'banana': 2,
    'cherry': 0,
    'date': 12
}

apple_count = fruits_in_bowl['apple'] # Equals 4

fruits_in_bowl['pear'] = 9 # Sets 'pear' in the dictionary to 9.

for fruit, num in fruits_in_bowl.items():
    print(f"There are {num} {fruit}(s) in the bowl." % (num, fruit))

If you only want the keys from a dictionary, you can just iterate over it directly, like this:

for fruit in fruits_in_bowl:
    print(fruit)

If you want only the values but not the keys from a dictionary, use my_dictionary.values().

Sets

A set is an unordered collection of unique items, with constant-time membership checking.

fruits = {'Apple', 'Apple', 'Apple', 'Pear'} # The set removes duplicates, so it will only contain {'Apple', 'Pear'}
fruits = set(['Apple', 'Apple', 'Apple', 'Pear']) # This line transforms a list into a set
print('Apple' in fruits) # Constant-time!


Loops

In Python, while loops are written like this:

i = 0
while i < 10:
    i += 1

For loops are written like this:

pets = ['Dog', 'Cat', 'Fish']

for pet in pets:
    print(pet)

To iterate over a range of numbers, you can use the convenient range function, like so:

for i in range(20, 30): # If you omit the first argument to range, it's assumed to be zero.
    print(i)

Note that range provides a closed-open range. That is to say, it is inclusive of its lower bound and exclusive of its upper bound. To be very explicit about it:

list(range(3, 6)) == [3, 4, 5]

Unlike in other languages you may know, the following is not good practice in Python:

pets = ['Dog', 'Cat', 'Fish']

# BAD PRACTICE. DO NOT USE.
for i in range(len(pets)):
    pet = pets[i]

Instead, if you need to access both a variable and its index, use the enumerate function, which allows you to iterate through a group of items, along with their indexes, like so:

pets = ['Dog', 'Cat', 'Fish']

for index, pet in enumerate(pets):
    print(f"{pet} at index {index}")

Generator Expressions and Comprehensions

A generator is a special kind of object that, basically, represents a collection of items using a value and a function for generating the next value in the collection. In other words, it's a way of creating something that behaves like a list, but which only generates one value at a time, and discards a value when it's done with it. Say, for example, you wanted to do an operation on 10,000,000,000,000 numbers. You could put them all in a list, then iterate over the list, but that would take a lot of memory, plus you'd have to create and fill the entire list before beginning to actually work on your problem. Instead, you'd probably be better off using a generator; telling the computer, essentially: “The starting value is 0. When I ask for the next number in the collection, add 1 to current value and give me that.”

A generator expression is an expression that is evaluated to create a generator. They're super useful. Generator expressions can take two forms – they can be used with and without a condition:

(EXPRESSION for VARIABLE in ITERABLE) # Unconditional
(EXPRESSION for VARIABLE in ITERABLE if CONDITION) # Conditional

For our purposes, you can think of an iterable as anything you can do a for loop over. Let's take a look at a generator expression in use:

double_even_digits = (number * 2 for number in range(10) if number % 2 == 0)

That line says that double_even_digits is every even number between 0 and 10 multiplied by two. Simple enough, right? If we wanted to use all of the numbers, not just the even ones, we could simply remove the if statement at the end of the expression.

Here's the thing, though: if you were to print double_even_digits, instead of a nice bunch of numbers, you'd get something that looks like this:

<generator object <genexpr>at 0x107fc92b0>

That's because generators are lazy! They don't generate their values until those values are needed, and they discard values once they're no longer needed. As a result, you can only iterate over a generator once. In this case, you can't print out the whole generator, because it hasn't generated all the values yet. You can, however, iterate over the generator, and print its values one at a time, like so:

for number in double_even_digits:
    print(number)

You can also make a list out of the generator, which will go through all the items in the generator and put them in a list, like so:

even_number_list = list(double_even_digits)

That's actually a great segue to the second topic of this section: comprehensions. A comprehension is just a prettier way to make lists, sets, and dicts out of a generator expressions.

# If you want a list:
list(i for i in range(10) if i % 2 == 0) # Don't do this
[i for i in range(10) if i % 2 == 0] # Use a list comprehension instead!

# If you want a set:
set(i for i in range(10) if i % 2 == 0) # Don't do this
{i for i in range(10) if i % 2 == 0} # Use a set comprehension instead!

# If you want a dict:
dict((i, i + 1) for i in range(10) if i % 2 == 0) # Don't do this
{i : i + 1 for i in range(10) if i % 2 == 0} # Use a dict comprehension instead!

# If you want a tuple:
tuple(i for i in range(10) if i % 2 == 0) # Unfortunately, there's no better way to do this

In general, generators and comprehensions should be used whenever possible - they're the fastest and easiest way to build collections. If you ever see yourself writing code like this:

# BAD PRACTICE! DO NOT USE!
digits = []
for digit in range(10):
    digits.append(digit)

Don't do it! Instead, use a generator expression or comprehension, as appropriate. A good way to decide whether a generator expression or comprehension is better for this situation is that, if you're just going to be iterating over your collection once, you should use an generator expression. If not, use a comprehension.

Sorting

Sorting in Python is frequently performed using the sorted function, which takes two arguments: an iterable (anything you can do a for-loop over, including lists and tuples) and a function used to evaluate each item. If the function is omitted, Python will try to sort the lists by value.

The following example demonstrates using an inline function, which Python calls a lambda.

fruits = ['apple', 'banana', 'cherry', 'date']

# sort the fruits by string length
new_fruits = sorted(fruits, key=lambda v: len(v) // 2)

print(new_fruits) # ['date', 'apple', 'banana', 'cherry']

Alternatively, you can sort a list using the .sort method. This is faster than calling sorted, but it modifies the list in-place and returns None.

fruits = ['apple', 'banana', 'cherry', 'date']
fruits.sort()

Import

If you want to use functions from other libraries (including ones that you install using pip), use import:

import time

current_time = time.localtime()
print(time.strftime('%a, %d %b %Y %H:%M:%S', current_time))

If you want to pull the functions out of their namespace, you can use from ___ import ___ syntax:

from time import localtime, strftime

current_time = localtime()
print(strftime('%a, %d %b %Y %H:%M:%S', current_time))

# Be aware that this technique, although convenient, may cause unexpected behavior if the function names that you're pulling out of the namespace are already used for other purposes in Python.

File I/O

You can read an entire file into a variable like this:

f = open("example.txt")
file_contents = f.read()

f.close() # free up memory when we're finished with the file

A better option is to use a with-block, which handles opening and closing the file for you automatically:

with open("example.txt") as f:
    file_contents = f.read()

You can read a file line-by-line like this:

with open("example.txt") as f:
    for line in f:
        print(f"Read line: {line.strip()}")

You can write to a file like this:

with open("example.txt", "w") as f:
    f.write("Hello\nWorld\n")

Command-Line Arguments

Command line arguments are accessible in the variable sys.argv.

The following example shows a program that expects a filename as its argument, and it prints a usage message if the argument is not present (source).

import sys, os

if len(sys.argv) < 2:
    sys.exit(f"Usage: {sys.argv[0]} filename")

filename = sys.argv[1]

if not os.path.exists(filename):
    sys.exit(f"Error: File '{sys.argv[1]}' not found")

Object-Oriented Programming

You can define and use a class like this:

class Food:
    # constructor:
    def __init__(self, name):
        self.name = name
   
    def format_name(self):
        return f"Gotta love to eat {self.name}"

class Fruit(Food):
    def get_definition(self):
        return f"{self.format_name()} (fruit)"

fruit = Fruit("Cherry")
print(fruit.format_name())
print(fruit.get_definition())

This is the same example as in the PHP guide.

Some things to notice:

  • Instance methods always take self as their first argument, followed by any number of additional parameters. This can be misleading for programmers familiar with other languages, because the number of arguments you feed to the method is actually one less than the number of declared parameters. Whenever you call a method on a class instance, that instance is implicitly fed into the explicitly-declared self parameter of the method.
    Note that the self variable has the same purpose as the this variable in languages like PHP, Java, JavaScript, and C++.
  • There is no need for a new keyword in Python.

Footnotes

  1. ^ This is an oversimplification. If you're interested, here's a quick explanation of how: In CPython (the reference implementation of Python) programs are compiled to bytecode, an intermediate representation, which is then interpreted.