Pages

Friday, January 1, 2010

Indentation


Whitespace is important in Python. Actually, whitespace at the beginning of the line is important.
This is called indentation. Leading whitespace (spaces and tabs) at the beginning of the logical line is
used to determine the indentation level of the logical line, which in turn is used to determine the grouping
of statements.
This means that statements which go together must have the same indentation. Each such set of statements
is called a block. We will see examples of how blocks are important in later chapters.
One thing you should remember is how wrong indentation can give rise to errors. For example:
i = 5
print 'Value is', i # Error! Notice a single space at the start of the line
print 'I repeat, the value is', i
When you run this, you get the following error:
File "whitespace.py", line 4
print 'Value is', i # Error! Notice a single space at the start of the line
^
SyntaxError: invalid syntax
Notice that there is a single space at the beginning of the second line. The error indicated by Python tells
us that the syntax of the program is invalid i.e. the program was not properly written. What this means to
you is that you cannot arbitrarily start new blocks of statements (except for the main block which you
have been using all along, of course). Cases where you can use new blocks will be detailed in later
chapters such as the control flow chapter.
How to indent
Do not use a mixture of tabs and spaces for the indentation as it does not work across different
platforms properly. I strongly recommend that you use a single tab or two or four spaces for
each indentation level.
Choose any of these three indentation styles. More importantly, choose one and use it consistently
i.e. use that indentation style only.

Logical and Physical Lines


A physical line is what you see when you write the program. A logical line is what Python sees as a
single statement. Python implicitly assumes that each physical line corresponds to a logical line.
An example of a logical line is a statement like print 'Hello World' - if this was on a line by itself
(as you see it in an editor), then this also corresponds to a physical line.
Implicitly, Python encourages the use of a single statement per line which makes code more readable.
If you want to specify more than one logical line on a single physical line, then you have to explicitly
specify this using a semicolon (;) which indicates the end of a logical line/statement. For example,
i = 5
print i
is effectively same as


i = 5;
print i;
and the same can be written as
i = 5; print i;
or even
i = 5; print i
However, I strongly recommend that you stick to writing a single logical line in a single physical line
only. Use more than one physical line for a single logical line only if the logical line is really long. The
idea is to avoid the semicolon as far as possible since it leads to more readable code. In fact, I have never
used or even seen a semicolon in a Python program.
An example of writing a logical line spanning many physical lines follows. This is referred to as explicit
line joining.
s = 'This is a string. \
This continues the string.'
print s
This gives the output:
This is a string. This continues the string.
Similarly,
print \
i
is the same as


print i
Sometimes, there is an implicit assumption where you don't need to use a backslash. This is the case
where the logical line uses parentheses, square brackets or curly braces. This is is called implicit line
joining. You can see this in action when we write programs using lists in later chapters.


Objects


Remember, Python refers to anything used in a program as an object. This is meant in the generic sense.
Instead of saying 'the something', we say 'the object'.
Note for Object Oriented Programming users
Python is strongly object-oriented in the sense that everything is an object including numbers,
strings and even functions.
We will now see how to use variables along with literal constants. Save the following example and run
the program.
How to write Python programs
Henceforth, the standard procedure to save and run a Python program is as follows:
1. Open your favorite editor.
2. Enter the program code given in the example.
3. Save it as a file with the filename mentioned in the comment. I follow the convention of
having all Python programs saved with the extension .py.
4. Run the interpreter with the command python program.py or use IDLE to run the programs.
You can also use the executable method as explained earlier.
Example 4.1. Using Variables and Literal constants
# Filename : var.py
i = 5
print i
i = i + 1
print i
s = '''This is a multi-line string.
This is the second line.'''
print s


Output
$ python var.py
56
This is a multi-line string.
This is the second line.


How It Works
Here's how this program works. First, we assign the literal constant value 5 to the variable i using the
assignment operator (=). This line is called a statement because it states that something should be done
and in this case, we connect the variable name i to the value 5. Next, we print the value of i using the
print statement which, unsurprisingly, just prints the value of the variable to the screen.
The we add 1 to the value stored in i and store it back. We then print it and expectedly, we get the value
6.
Similarly, we assign the literal string to the variable s and then print it.
Note for C/C++ Programmers
Variables are used by just assigning them a value. No declaration or data type definition is
needed/used.




Identifier Naming


Variables are examples of identifiers. Identifiers are names given to identify something. There are some
rules you have to follow for naming identifiers:
• The first character of the identifier must be a letter of the alphabet (upper or lowercase) or an underscore
('_').
• The rest of the identifier name can consist of letters (upper or lowercase), underscores ('_') or digits
(0-9).
• Identifier names are case-sensitive. For example, myname and myName are not the same. Note the
lowercase n in the former and the uppercase N in te latter.

Examples of valid identifier names are i, __my_name, name_23 and a1b2_c3.
• Examples of invalid identifier names are 2things, this is spaced out and my-name.

Strings


A string is a sequence of characters. Strings are basically just a bunch of words.
I can almost guarantee that you will be using strings in almost every Python program that you write, so
pay attention to the following part. Here's how you use strings in Python:
•
Using Single Quotes (')
You can specify strings using single quotes such as 'Quote me on this' . All white space i.e.
spaces and tabs are preserved as-is.
•
Using Double Quotes (")
Strings in double quotes work exactly the same way as strings in single quotes. An example is
"What's your name?"
•
Using Triple Quotes (''' or """)
You can specify multi-line strings using triple quotes. You can use single quotes and double quotes
freely within the triple quotes. An example is

'''This is a multi-line string. This is the first line.
This is the second line.
"What's your name?," I asked.
He said "Bond, James Bond."
'''
•
Escape Sequences
Suppose, you want to have a string which contains a single quote ('), how will you specify this
string? For example, the string is What's your name?. You cannot specify 'What's your
name?' because Python will be confused as to where the string starts and ends. So, you will have to
specify that this single quote does not indicate the end of the string. This can be done with the help
of what is called an escape sequence. You specify the single quote as \' - notice the backslash.
Now, you can specify the string as 'What\'s your name?'.
Another way of specifying this specific string would be "What's your name?" i.e. using
double quotes. Similarly, you have to use an escape sequence forusing a double quote itself in a
double quoted string. Also, you have to indicate the backslash itself using the escape sequence \\.
What if you wanted to specify a two-line string? One way is to use a triple-quoted string as shown
above or you can use an escape sequence for the newline character - \n to indicate the start of a new
line. An example is This is the first line\nThis is the second line . Another
useful escape sequence to know is the tab - \t. There are many more escape sequences but I have
mentioned only the most useful ones here.
One thing to note is that in a string, a single backslash at the end of the line indicates that the string
is continued in the next line, but no newline is added. For example,
"This is the first sentence.\
This is the second sentence."
is equivalent to "This is the first sentence. This is the second sentence."
•
Raw Strings
If you need to specify some strings where no special processing such as escape sequences are
handled, then what you need is to specify a raw string by prefixing r or R to the string. An example
is r"Newlines are indicated by \n".
•
Unicode Strings
Unicode is a standard way of writing international text. If you want to write text in your native language
such as Hindi or Arabic, then you need to have a Unicode-enabled text editor. Similarly, Python
allows you to handle Unicode text - all you need to do is prefix u or U. For example, u"This
is a Unicode string.".


Remember to use Unicode strings when you are dealing with text files, especially when you know
that the file will contain text written in languages other than English.
•
Strings are immutable
This means that once you have created a string, you cannot change it. Although this might seem like
a bad thing, it really isn't. We will see why this is not a limitation in the various programs that we see
later on.
•
String literal concatenation
If you place two string literals side by side, they are automatically concatenated by Python. For example,
'What\'s' 'your name?' is automatically converted in to "What's your
name?".
Note for C/C++ Programmers
There is no separate char data type in Python. There is no real need for it and I am sure you
won't miss it.
Note for Perl/PHP Programmers
Remember that single-quoted strings and double-quoted strings are the same - they do not differ
in any way.
Note for Regular Expression Users
Always use raw strings when dealing with regular expressions. Otherwise, a lot of backwhacking
may be required. For example, backreferences can be referred to as '\\1' or r'\1'.


Numbers


Numbers in Python are of four types - integers, long integers, floating point and complex numbers.
• Examples of integers are 2 which are just whole numbers.
• Long integers are just bigger whole numbers.
• Examples of floating point numbers (or floats for short) are 3.23 and 52.3E-4. The E notation indicates
powers of 10. In this case, 52.3E-4 means 52.3 * 10-4.
• Examples of complex numbers are (-5+4j) and (2.3 - 4.6j)

Getting Help


If you need quick information about any function or statement in Python, then you can use the built-in
help functionality. This is very useful especially when using the interpreter prompt. For example, run
help(str) - this displays the help for the str class which is used to store all text (strings) that you
use in your program. Classes will be explained in detail in the chapter on object-oriented programming.
Note
Press q to exit the help.
Similarly, you can obtain information about almost anything in Python. Use help() to learn more
about using help itself!
In case you need to get help for operators like print, then you need to set the PYTHONDOCS environment
variable appropriately. This can be done easily on Linux/Unix using the env command.
$ env PYTHONDOCS=/usr/share/doc/python-docs-2.3.4/html/ python
Python 2.3.4 (#1, Oct 26 2004, 16:42:40)
[GCC 3.4.2 20041017 (Red Hat 3.4.2-6.fc3)] on linux2

Type "help", "copyright", "credits" or "license" for more information.
>>> help('print')
You will notice that I have used quotes to specify 'print' so that Python can understand that I want
to fetch help about 'print' and I am not asking it to print something.
Note that the location I have used is the location in Fedora Core 3 Linux - it may be different for different
distributions and versions.

Executable Python programs


This applies only to Linux/Unix users but Windows users might be curious as well about the first line of
the program. First, we have to give the program executable permission using the chmod command then
run the source program.
$ chmod a+x helloworld.py
$ ./helloworld.py
Hello World
The chmod command is used here to change the mode of the file by giving execute permission to all
users of the system. Then, we execute the program directly by specifying the location of the source file.
We use the ./ to indicate that the program is located in the current directory.
To make things more fun, you can rename the file to just helloworld and run it as ./helloworld and it


will still work since the system knows that it has to run the program using the interpreter whose location
is specified in the first line in the source file.
You are now able to run the program as long as you know the exact path of the program - but what if
you wanted to be able to run the program from anywhere? You can do this by storing the program in one
of the directories listed in the PATH environment variable. Whenever you run any program, the system
looks for that program in each of the directories listed in the PATH environment variable and then runs
that program. We can make this program available everywhere by simply copying this source file to one
of the directories listed in PATH.
$ echo $PATH
/opt/mono/bin:/usr/local/bin:/usr/bin:/bin:/usr/X11R6/bin:/home/swaroop/bin
$ cp helloworld.py /home/swaroop/bin/helloworld
$ helloworld
Hello World
We can display the PATH variable using the echo command and prefixing the variable name by $ to indicate
to the shell that we need the value of this variable. We see that /home/swaroop/bin is one of
the directories in the PATH variable where swaroop is the username I am using in my system. There
will usually be a similar directory for your username on your system. Alternatively, you can add a directory
of your choice to the PATH variable - this can be done by running
PATH=$PATH:/home/swaroop/mydir where '/home/swaroop/mydir' is the directory I want to
add to the PATH variable.
This method is very useful if you want to write useful scripts that you want to run the program anytime,
anywhere. It is like creating your own commands just like cd or any other commands that you use in the
Linux terminal or DOS prompt.
Caution
W.r.t. Python, a program or a script or software all mean the same thing.