Lesson 09 - 'Borrowing' other people's stuff (with modules).
Introduction
Last lesson we covered the killer topic of Classes. As you can remember, classes are neat combinations of variables and functions in a nice, neat package. Programming lingo calls this feature
encapsulation, but reguardless of what it is called, it's a really cool feature for keeping things together so the code can be used in many
instances in lots of places. Of course, you've got to ask, "how do I get my classes to many places?". The answer is to put them into a
module, to be imported into other programs.
Module? What's a Module?
A module is a python file that (generally) has only defenitions of variables, functions, and classes. For example, a module might look like this:
Code:
### moduletest.py
### EXAMPLE PYTHON MODULE
# Define some variables:
numberone = 1
ageofqueen = 78
# define some functions
def printhello():
print "hello"
def timesfour(input):
print input * 4
# define a class
class Piano:
def __init__(self):
self.type = raw_input("What type of piano? ")
self.height = raw_input("What height (in feet)? ")
self.price = raw_input("How much did it cost? ")
self.age = raw_input("How old is it (in years)? ")
def printdetails(self):
print "This piano is a/an " + self.height + " foot",
print self.type, "piano, " + self.age, "years old and costing " + self.price + " dollars."
Save the above as moduletest.py
So what do we do with a module? We
import bits of it (or all of it) into other programs.
To import all the variables, functions and classes from moduletest.py into another program you are writing, we use the
import operator. For example, to import moduletest.py into your main program, you would have this:
Code:
### mainprogam.py
### IMPORTS ANOTHER MODULE
import moduletest
This assumes that the module is in the same directory as mainprogram.py, or is a default module that comes with python. You leave out the '.py' at the end of the file - it is ignored. You normally put all
import statements at the beginning of the python file, but technically it is not required. In order to use the items in the module in your main program, you use the following:
Code:
### mainprogram.py continued
### USING AN IMPORTED MODULE
# Use the form modulename.itemname
# Examples:
print moduletest.ageofqueen
cfcpiano = moduletest.Piano()
cfcpiano.printdetails()
More module thingummyjigs (in lack of a better title)
Ever wish you could get rid of the
modulename. part that you have to put before every item you use from a module? No? Never? Well, I'll teach it you anyway.
To do this, you use the
from operator. You use it in the form of
from modulename import itemname. Here is an example:
Code:
### directimport.py
### IMPORT ITEMS DIRECTLY INTO YOUR PROGRAM
# import them
from moduletest import ageofqueen
from moduletest import printhello
# now try using them
print ageofqueen
printhello()
What is the point of this? Well, maybe you could use it to make your code a little more readable. If we get into heaps of modules inside modules, it could remove that extra layer of crypticness.
If you wanted to, you could import everything from a module is this way by putting
from modulename import *. Of course, this can be troublesome if there are objects in your program with the same name as some items in the module. With large modules, this can easily happen, and can cause many a headache. A better way to do this would be to import a module in the normal way (without the
from operator) and then assign items to a local name:
Code:
### mainprogram.py continued
### ASSIGNING ITEMS TO A LOCAL NAME
# Assigning to a local name
timesfour = moduletest.timesfour
# Using the local name
print timesfour(565)
This way, you can remove some crypticness, AND have all of the items from a certain module.
Conclusion
That's it! A very simple lesson, but now you can organise your programs very neatly. In fact, now it is increadibly easy to make progams that can grow in complexity without ending up with one cryptic file that is full of bugs.
Modules are great for importing code. Next lesson, we learn about file input and output, and the saving of information inside classes, to be retrieved later. Will be great! But until then...
Thanks to all,
Gingerbread Man
