Problem Solving and Python Programming
Problem Solving and Python Programming
Files and exception: text files, reading and writing files, format operator;
command line arguments, errors and exceptions, handling exceptions, modules,
packages; Illustrative programs: word count, copy file.
FILES
File is a named location on disk to store related information. It is used to
permanently store data in a non-volatile memory (e.g. hard disk). Since, random
access memory (RAM) is volatile which loses its data when computer is turned
off, we use files for future use of the data.
When we want to read from or write to a file we need to open it first. When we
are done, it needs to be closed, so that resources that are tied with the file are
freed. Hence, in Python, a file operation takes place in the following order.
1. Open a file
2. Read or write (perform operation)
3. Close the file
Opening a file
Python has a built-in function open() to open a file. This function returns a
file object, also called a handle, as it is used to read or modify the file accordingly.
>>> f = open("test.txt") # open file in current directory
>>> f = open("C:/Python33/README.txt") # specifying full path
We can specify the mode while opening a file. In mode, we specify whether
we want to read 'r', write 'w' or append 'a' to the file. We also specify if we want to
open the file in text mode or binary mode. The default is reading in text mode. In
this mode, we get strings when reading from the file. On the other hand, binary
mode returns bytes and this is the mode to be used when dealing with non-text
files like image or exe files.
Open a file for writing. Creates a new file if it does not exist or truncates
the file if it
'w'
exists.
Open a file for exclusive creation. If the file already exists, the operation
'x' fails.
Open for appending at the end of the file without truncating it. Creates a
new file if it
'a'
does not exist.
Closing a file will free up the resources that were tied with the file and is done
using the close() method.
Python has a garbage collector to clean up unreferenced objects but, we must not
rely on it to close the file.
f = open("test.txt",encoding = 'utf-8')
# perform file
operations f.close()
This method is not entirely safe. If an exception occurs when we are performing
some operation with the file, the code exits without closing the file. A safer way is
to use a try...finally block.
try:
f = open("test.txt",encoding = 'utf-8')
# perform file operations
finally:
f.close()
This way, we are guaranteed that the file is properly closed even if an exception is
raised, causing program flow to stop. The best way to do this is using the with
statement. This ensures that the file is closed when the block inside with is exited.
We don't need to explicitly call the close() method. It is done internally.
with open("test.txt",encoding = 'utf-8') as f:
# perform file operations
Reading and writing
A text file is a sequence of characters stored on a permanent medium like a hard
drive, flash memory, or CD-ROM.
read() : This function reads the entire file and returns a string
readline() : This function reads lines from that file and returns as a string. It
fetch the line n, if it is been called nth time.
readlines() : This function returns a list where each element is single line of
that file.
write() : This function writes a fixed sequence of characters to a file.
writelines() : This function writes a list of string.
append() : This function append string to the file instead of overwriting the
file.
To write a file, you have to open it with mode 'w' as a second parameter:
>>> fout = open('output.txt', 'w')
>>>fout.write(line1)
Again, the file object keeps track of where it is, so if you call write again, it adds
the new data to the end.
>>> fout.write(line2)
When you are done writing, you have to close the file.
>>> fout.close()
Format operator
The argument of write has to be a string, so if we want to put other values in a file,
we have to convert them to strings. The easiest way to do that is with str:
>>> x = 52
>>> fout.write(str(x))
The first operand is the format string, which contains one or more format
sequences, which specify how the second operand is formatted. The result is a
string.
For example, the format sequence '%d' means that the second operand should be
formatted as an integer (d stands for “decimal”):
>>> camels = 42
>>> '%d' % camels
'42'
The result is the string '42', which is not to be confused with the integer value 42.
A format sequence can appear anywhere in the string, so you can embed a value in
a sentence:
>>> camels = 42
The os module provides functions for working with files and directories (“os”
stands for “operating system”). os.getcwd returns the name of the current directory:
>>> import os
>>> cwd = os.getcwd()
>>> print cwd
/home/dinsdale
cwd stands for “current working directory.” The result in this example is
/home/dinsdale, which is the home directory of a user named dinsdale.
A string like cwd that identifies a file is called a path. A relative path starts from
the current directory; an absolute path starts from the topmost directory in the file
system.
The paths we have seen so far are simple filenames, so they are relative to the
current directory. To find the absolute path to a file, you can use os.path.abspath:
>>> os.path.abspath('memo.txt')
'/home/dinsdale/memo.txt'
os.path.exists checks whether a file or directory exists:
>>> os.path.exists('memo.txt')
True
If it exists, os.path.isdir checks whether it‟s a directory:
>>> os.path.isdir('memo.txt')
False
>>> os.path.isdir('music')
True
7
def walk(dirname):
for name in os.listdir(dirname):
path = os.path.join(dirname, name)
if os.path.isfile(path):
print path
else:
walk(path)
os.path.join takes a directory and a file name and joins them into a complete path.
Command Line Arguments
• Python supports the creation of programs that can be run on the command
line, completely with command-line arguments.
• It provides a getopt module, that help to parse command line options and
arguments .
Accessing Command Line Arguments
• The Python sys module provides access to any of the command-line
arguments via sys.argv. It solves two purposes:
• sys.argv is the list of command line arguments
• len(sys.argv) is the number of command line arguments that you have in
your command line
• sys.argv[0] is the program, i.e. script name
Executing Python
8
>>> if a < 3
File "<interactive input>", line 1
if a < 3
^
SyntaxError: invalid syntax
Errors can also occur at runtime and these are called exceptions. They
occur, for example, when a file we try to open does not exist
(FileNotFoundError), dividing a number by zero (ZeroDivisionError), module we
try to import is not found (ImportError) etc. Whenever these type of runtime error
occur, Python creates an exception object. If not handled properly, it prints a
traceback to that error along with some details about why that error occurred.
>>> 1 / 0
Traceback (most recent call last):
File "<string>", line 301, in runcode
File "<interactive input>", line 1, in
<module> ZeroDivisionError: division by
zero
>>> open("imaginary.txt")
10
represented
ReferenceError Raised when a weak reference proxy is used to access a
garbage collected referent
RuntimeError Raised when an error does not fall under any other
category.
StopIteration Raised by next() function to indicate that there is no
further item to be returned by iterator.
SyntaxError Raised by parser when syntax error is encountered.
IndentationError Raised when there is incorrect indentation.
SystemError Raised when interpreter detects internal error.
SystemExit Raised by sys.exit() function.
TypeError Raised when a function or operation is applied to an
object of incorrect type
UnboundLocalError Raised when a reference is made to a local variable in a
function or method, but no value has been bound to that
variable.
UnicodeError Raised when a Unicode-related encoding or decoding
error occurs.
UnicodeEncodeError Raised when a Unicode-related error occurs during
encoding
UnicodeDecodeError Raised when a Unicode-related error occurs during
decoding.
ValueError Raised when a function gets argument of correct type but
improper value.
ZeroDivisionError Raised when second operand of division or modulo
operation is zero.
We can handle these built-in and user-defined exceptions in Python using
try, except and finally statements.
For example, if function A calls function B which in turn calls function C and an
exception occurs in function C. If it is not handled in C, the exception passes to B
and then to A.
12
If never handled, an error message is spit out and our program come to a sudden,
unexpected halt.
Catching Exceptions in Python
In Python, exceptions can be handled using a try statement.
A critical operation which can raise exception is placed inside the try clause and
the code that handles exception is written in except clause.
It is up to us, what operations we perform once we have caught the exception. Here
is a simple example.
try...finally
The try statement in Python can have an optional finally clause. This clause
is executed no matter what, and is generally used to release external resources.
For example, we may be connected to a remote data center through the network or
working with a file or working with a Graphical User Interface (GUI).
In all these circumstances, we must clean up the resource once used, whether it
was successful or not. These actions (closing a file, GUI or disconnecting from
network) are performed in the finally clause to guarantee execution. Here is an
example of file operations to illustrate this.
try:
f = open("test.txt",encoding = 'utf-8')
# perform file operations
finally:
f.close()
Exceptions versus Syntax Errors
Syntax errors occur when the parser detects an incorrect statement. Observe the
following example:
14
>>> print( 0 / 0 ))
File "<stdin>", line 1
print( 0 / 0 ))
^
SyntaxError: invalid syntax
The arrow indicates where the parser ran into the syntax error. In this example,
there was one bracket too many. Remove it and run your code again:
>>> print( 0 / 0)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
ZeroDivisionError: integer division or modulo by zero
This time, you ran into an exception error. This type of error occurs whenever
syntactically correct Python code results in an error. The last line of the message
indicated what type of exception error you ran into.
Instead of showing the message exception error, Python details what type of
exception error was encountered. In this case, it was a ZeroDivisionError. Python
comes with various built-in exceptions as well as the possibility to create self-
defined exceptions.
What is Exception?
An exception is an event, which occurs during the execution of a program that
disrupts the normal flow of the program's instructions. In general, when a Python
script encounters a situation that it cannot cope with, it raises an exception. An
exception is a Python object that represents an error.
When a Python script raises an exception, it must either handle the exception
immediately otherwise it terminates and quits.
List of Standard Exceptions −
1 Exception
Base class for all exceptions
15
2 StopIteration
Raised when the next() method of an iterator does not point to any object.
3 SystemExit
Raised by the sys.exit() function.
4 StandardError
Base class for all built-in exceptions except StopIteration and SystemExit.
5 ArithmeticError
Base class for all errors that occur for numeric calculation.
6 OverflowError
Raised when a calculation exceeds maximum limit for a numeric type.
7 FloatingPointError
Raised when a floating point calculation fails.
8 ZeroDivisionError
Raised when division or modulo by zero takes place for all numeric types.
9 AssertionError
Raised in case of failure of the Assert statement.
10 AttributeError
Raised in case of failure of attribute reference or assignment.
11 EOFError
Raised when there is no input from either the raw_input() or input() function
16
12 ImportError
Raised when an import statement fails.
13 KeyboardInterrupt
Raised when the user interrupts program execution, usually by pressing
Ctrl+c.
14 LookupError
Base class for all lookup errors.
15 IndexError
Raised when an index is not found in a sequence.
16 KeyError
Raised when the specified key is not found in the dictionary.
17 NameError
Raised when an identifier is not found in the local or global namespace.
18 UnboundLocalError
Raised when trying to access a local variable in a function or method but no
value has been assigned to it.
19 EnvironmentError
Base class for all exceptions that occur outside the Python environment.
20 IOError
Raised when an input/ output operation fails, such as the print statement or
17
the open() function when trying to open a file that does not exist.
21 IOError
Raised for operating system-related errors.
22 SyntaxError
Raised when there is an error in Python syntax.
23 IndentationError
Raised when indentation is not specified properly.
24 SystemError
Raised when the interpreter finds an internal problem, but when this error is
encountered the Python interpreter does not exit.
25 SystemExit
Raised when Python interpreter is quit by using the sys.exit() function. If not
handled in the code, causes the interpreter to exit.
26 TypeError
Raised when an operation or function is attempted that is invalid for the
specified data type.
27 ValueError
Raised when the built-in function for a data type has the valid type of
arguments, but the arguments have invalid values specified.
28 RuntimeError
Raised when a generated error does not fall into any category.
18
29 NotImplementedError
Raised when an abstract method that needs to be implemented in an inherited
class is not actually implemented.
Handling an exception
If you have some suspicious code that may raise an exception, you can defend
your program by placing the suspicious code in a try: block. After the try: block,
include an except: statement, followed by a block of code which handles the
problem as elegantly as possible.
The except Clause with No Exceptions
You can also use the except statement with no exceptions defined as follows −
try:
You do your operations here;
......................
except:
If there is any exception, then execute this block.
......................
else:
If there is no exception then execute this block.
This kind of a try-except statement catches all the exceptions that occur. Using
this kind of try-except statement is not considered a good programming practice
though, because it catches all exceptions but does not make the programmer
identify the root cause of the problem that may occur.
Syntax
except ExceptionII:
If there is ExceptionII, then execute this block.
......................
else:
If there is no exception then execute this block.
A single try statement can have multiple except statements. This is useful
when the try block contains statements that may throw different types of
exceptions.
You can also provide a generic except clause, which handles any exception.
After the except clause(s), you can include an else-clause. The code in the
else-block executes if the code in the try: block does not raise an exception.
The else-block is a good place for code that does not need the try: block's
protection.
Example
try:
fh = open("testfile", "w")
fh.write("This is my test file for exception handling!!")
except IOError:
print "Error: can\'t find file or read data"
else:
print "Written content in the file successfully"
fh.close()
This produces the following result −
Written content in the file successfully
Example
This example tries to open a file where you do not have write permission, so it
raises an exception −
try:
fh = open("testfile", "r")
fh.write("This is my test file for exception handling!!")
except IOError:
20
Example
21
#!/usr/bin/python
try:
fh = open("testfile", "w")
fh.write("This is my test file for exception handling!!")
finally:
print "Error: can\'t find file or read data"
If you do not have permission to open the file in writing mode, then this will
produce the following result −
Error: can't find file or read data
Same example can be written more cleanly as follows −
#!/usr/bin/python
try:
fh = open("testfile", "w")
try:
fh.write("This is my test file for exception handling!!")
finally:
print "Going to close the file"
fh.close()
except IOError:
print "Error: can\'t find file or read data"
When an exception is thrown in the try block, the execution immediately passes to
the finally block. After all the statements in the finally block are executed, the
exception is raised again and is handled in the except statements if present in the
next higher layer of the try-except statement.
Argument of an Exception
An exception can have an argument, which is a value that gives additional
information about the problem. The contents of the argument vary by exception.
You capture an exception's argument by supplying a variable in the except clause
as follows −
try:
You do your operations here;
......................
22
Example
Syntax
The final argument, traceback, is also optional (and rarely used in practice), and if
present, is the traceback object used for the exception.
Example
An exception can be a string, a class or an object. Most of the exceptions that the
Python core raises are classes, with an argument that is an instance of the class.
Defining new exceptions is quite easy and can be done as follows −
def functionName( level ):
if level < 1:
raise "Invalid level!", level
# The code below to this would not be executed
# if we raise the exception
Note: In order to catch an exception, an "except" clause must refer to the same
exception thrown either class object or simple string. For example, to capture
above exception, we must write the except clause as follows −
try:
Business Logic here...
except "Invalid level!":
Exception handling here...
else:
Rest of the code here...
User-Defined Exceptions
Python also allows you to create your own exceptions by deriving classes from the
standard built-in exceptions.
Here is an example related to RuntimeError. Here, a class is created that is
subclassed from RuntimeError. This is useful when you need to display more
specific information when an exception is caught.
In the try block, the user-defined exception is raised and caught in the except
block. The variable e is used to create an instance of the class Networkerror.
class Networkerror(RuntimeError):
def __init__(self, arg):
self.args = arg
So once you defined above class, you can raise the exception as follows −
24
try:
raise Networkerror("Bad hostname")
except Networkerror,e:
print e.args
MODULES
Any file that contains Python code can be imported as a module. For
example, suppose you have a file named wc.py with the following code:
def linecount(filename):
count = 0
for line in open(filename):
count += 1
return count
print linecount('wc.py')
If you run this program, it reads itself and prints the number of lines in the file,
which is 7.
You can also import it like this:
>>> import wc
7
Now you have a module object wc:
>>> print wc
<module 'wc' from 'wc.py'>
>>> wc.linecount('wc.py')
7
The only problem with this example is that when you import the module it
executes the test code at the bottom. Normally when you import a module, it
defines new functions but it doesn‟t execute them.
if __name__ == '__main__':
print linecount('wc.py')
__name__ is a built-in variable that is set when the program starts. If the program
is running as a script, __name__ has the value __main__; in that case, the test
code is executed. Otherwise, if the module is being imported, the test code is
skipped. Eg:
# import module
import calendar
yy = 2017
mm = 8
# To ask month and year from the user
# yy = int(input("Enter year: "))
# mm = int(input("Enter month: "))
# display the calendar
print(calendar.month(yy,
mm))
PACKAGE
A package is a collection of modules. A Python package can have sub-
packages and modules. A directory must contain a file named __init__.py in order
for Python to consider it as a package. This file can be left empty but we generally
place the initialization code for that package in this file. Here is an example.
Suppose we are developing a game, one possible organization of packages and
modules could be as shown in the figure below.
26
Now if this module contains a function named select_difficulty(), we must use the
full name to reference it.
Game.Level.start.select_difficulty(2)
If this construct seems lengthy, we can import the module without the package
prefix as follows.
from Game.Level import start
We can now call the function simply as follows.
start.select_difficulty(2)
Yet another way of importing just the required function (or class or variable) form
a module within a package would be as follows.
• Step 1: Create a folder name “MyPackage” in the folder where the python
files are storing.
• Step 3: Type a python program containing the function to add two numbers
with function name “add” and save the file inside the folder “Add” by the
name “addition”
ILLUSTRATION PROGRAM
Word Count
import sys
file=open("/Python27/note.txt","r+")
wordcount={}
for word in file.read().split():
if word not in wordcount:
wordcount[word] = 1
else:
wordcount[word] += 1
file.close();
print ("%-30s %s " %('Words in the File' , 'Count'))
for key in wordcount.keys():
print ("%-30s %d " %(key , wordcount[key]))