Python - Modules

Python Modules

The concept ofmodule in Python further enhances the modularity. You can define more than one related functions together and load required functions. A module is a file containing definition of functions,classes,variables, constants or any other Python object. Contents of this file can be made available to any other program. Python has theimport keyword for this purpose.

Afunction is a block of organized, reusable code that is used to perform a single, related action. Functions provide better modularity for your application and a high degree of code reusing.

Example of Python Module

import mathprint ("Square root of 100:", math.sqrt(100))

It will produce the followingoutput −

Square root of 100: 10.0

Python Built-in Modules

Python's standard library comes bundled with a large number of modules. They are called built-in modules. Most of these built-in modules are written in C (as the reference implementation of Python is in C), and pre-compiled into the library. These modules pack useful functionality like system-specific OS management, disk IO, networking, etc.

Here is a select list of built-in modules −

Python User-defined Modules

Any text file with.py extension and containing Python code is basically a module. It can contain definitions of one or more functions, variables, constants as well as classes. Any Python object from a module can be made available to interpreter session or another Python script by import statement. A module can also include runnable code.

Creating a Python Module

Creating a module is nothing but saving a Python code with the help of any editor. Let us save the following code asmymodule.py

def SayHello(name):   print ("Hi {}! How are you?".format(name))   return

You can now import mymodule in the current Python terminal.

>>> import mymodule>>> mymodule.SayHello("Harish")Hi Harish! How are you?

You can also import one module in another Python script. Save the following code as example.py

import mymodulemymodule.SayHello("Harish")

Run this script from command terminal

Hi Harish! How are you?

The import Statement

In Python, theimport keyword has been provided to load a Python object from one module. The object may be a function, class, a variable etc. If a module contains multiple definitions, all of them will be loaded in the namespace.

Let us save the following code having three functions asmymodule.py.

def sum(x,y):   return x+ydef average(x,y):   return (x+y)/2def power(x,y):   return x**y

Theimport mymodule statement loads all the functions in this module in the current namespace. Each function in the imported module is an attribute of this module object.

>>> dir(mymodule)['__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'average', 'power', 'sum']

To call any function, use the module object's reference. For example, mymodule.sum().

import mymoduleprint ("sum:",mymodule.sum(10,20))print ("average:",mymodule.average(10,20))print ("power:",mymodule.power(10, 2))

It will produce the followingoutput −

sum:30average:15.0power:100

The from ... import Statement

The import statement will load all the resources of the module in the current namespace. It is possible to import specific objects from a module by using this syntax. For example −

Out of three functions inmymodule, only two are imported in following executable scriptexample.py

from mymodule import sum, averageprint ("sum:",sum(10,20))print ("average:",average(10,20))

It will produce the following output −

sum: 30average: 15.0

Note that function need not be called by prefixing name of its module to it.

The from...import * Statement

It is also possible to import all the names from a module into the current namespace by using the following import statement −

from modname import *

This provides an easy way to import all the items from a module into the current namespace; however, this statement should be used sparingly.

The import ... as Statement

You can assign an alias name to the imported module.

from modulename as alias

Thealias should be prefixed to the function while calling.

Take a look at the followingexample −

import mymodule as xprint ("sum:",x.sum(10,20))print ("average:", x.average(10,20))print ("power:", x.power(10, 2))

Locating Modules

When you import a module, the Python interpreter searches for the module in the following sequences −

• The current directory.

• If the module isn't found, Python then searches each directory in the shell variable PYTHONPATH.

• If all else fails, Python checks the default path. On UNIX, this default path is normally /usr/local/lib/python/.

The module search path is stored in the system module sys as thesys.path variable. The sys.path variable contains the current directory, PYTHONPATH, and the installation-dependent default.

ThePYTHONPATH Variable

The PYTHONPATH is an environment variable, consisting of a list of directories. The syntax of PYTHONPATH is the same as that of the shell variable PATH.

Here is a typical PYTHONPATH from a Windows system −

set PYTHONPATH = c:\python20\lib;

And here is a typical PYTHONPATH from a UNIX system −

set PYTHONPATH = /usr/local/lib/python

Namespaces and Scoping

Variables are names (identifiers) that map to objects. Anamespace is a dictionary of variable names (keys) and their corresponding objects (values).

• A Python statement can access variables in alocal namespace and in theglobal namespace. If a local and a global variable have the same name, the local variable shadows the global variable.

• Each function has its own local namespace. Class methods follow the same scoping rule as ordinary functions.

• Python makes educated guesses on whether variables are local or global. It assumes that any variable assigned a value in a function is local.

• In order to assign a value to a global variable within a function, you must first use the global statement.

• The statementglobal VarName tells Python that VarName is a global variable. Python stops searching the local namespace for the variable.

Example

For example, we define a variableMoney in the global namespace. Within the functionMoney, we assignMoney a value, therefore Python assumesMoney as a local variable. However, we accessed the value of the local variableMoney before setting it, so an UnboundLocalError is the result. Uncommenting the global statement fixes the problem.

Money = 2000def AddMoney():   # Uncomment the following line to fix the code:   # global Money   Money = Money + 1print (Money)AddMoney()print (Money)

Module Attributes

In Python, a module is an object of module class, and hence it is characterized by attributes.

Following are the module attributes −

• __file__ returns the physical name of the module.

• __package__ returns the package to which the module belongs.

• __doc__ returns the docstring at the top of the module if any

• __dict__ returns the entire scope of the module

• __name__ returns the name of the module

Example

Assuming that the following code is saved asmymodule.py

"The docstring of mymodule"def sum(x,y):   return x+ydef average(x,y):   return (x+y)/2   def power(x,y):   return x**y

Let us check the attributes of mymodule by importing it in the following script −

import mymoduleprint ("__file__ attribute:", mymodule.__file__)print ("__doc__ attribute:", mymodule.__doc__)print ("__name__ attribute:", mymodule.__name__)

It will produce the followingoutput −

__file__ attribute: C:\math\examples\mymodule.py__doc__ attribute: The docstring of mymodule__name__ attribute: mymodule

The __name__Attribute

The __name__ attribute of a Python module has great significance. Let us explore it in more detail.

In an interactive shell, __name__ attribute returns '__main__'

>>> __name__'__main__'

If you import any module in the interpreter session, it returns the name of the module as the __name__ attribute of that module.

>>> import math>>> math.__name__'math'

From inside a Python script, the __name__ attribute returns '__main__'

#example.pyprint ("__name__ attribute within a script:", __name__)

Run this in the command terminal −

__name__ attribute within a script: __main__

This attribute allows a Python script to be used as executable or as a module. Unlike in C++, Java, C# etc., in Python, there is no concept of the main() function. The Python program script with .py extension can contain function definitions as well as executable statements.

Savemymodule.py and with the following code −

"The docstring of mymodule"def sum(x,y):   return x+y   print ("sum:",sum(10,20))

You can see that sum() function is called within the same script in which it is defined.

sum: 30

Now let us import this function in another scriptexample.py.

import mymoduleprint ("sum:",mymodule.sum(10,20))

It will produce the followingoutput −

sum: 30sum: 30

The output "sum:30" appears twice. Once when mymodule module is imported. The executable statements in imported module are also run. Second output is from the calling script, i.e.,example.py program.

What we want to happen is that when a module is imported, only the function should be imported, its executable statements should not run. This can be done by checking the value of __name__. If it is __main__, means it is being run and not imported. Include the executable statements like function calls conditionally.

Addif statement inmymodule.py as shown −

"The docstring of mymodule"def sum(x,y):   return x+yif __name__ == "__main__":   print ("sum:",sum(10,20))

Now if you runexample.py program, you will find that the sum:30 output appears only once.

sum: 30

The dir( ) Function

The dir() built-in function returns a sorted list of strings containing the names defined by a module.

The list contains the names of all the modules, variables and functions that are defined in a module. Following is a simple example −

# Import built-in module mathimport mathcontent = dir(math)print (content)

When the above code is executed, it produces the following result −

['__doc__', '__file__', '__name__', 'acos', 'asin', 'atan', 'atan2', 'ceil', 'cos', 'cosh', 'degrees', 'e', 'exp', 'fabs', 'floor', 'fmod', 'frexp', 'hypot', 'ldexp', 'log','log10', 'modf', 'pi', 'pow', 'radians', 'sin', 'sinh', 'sqrt', 'tan', 'tanh']

The reload() Function

Sometimes you may need to reload a module, especially when working with the interactive interpreter session of Python.

Assume that we have a test module (test.py) with the following function −

def SayHello(name):   print ("Hi {}! How are you?".format(name))   return

We can import the module and call its function from Python prompt as −

>>> import test>>> test.SayHello("Deepak")Hi Deepak! How are you?

However, suppose you need to modify the SayHello() function, such as −

def SayHello(name, course):   print ("Hi {}! How are you?".format(name))   print ("Welcome to {} Tutorial by TutorialsPoint".format(course))   return

Even if you edit the test.py file and save it, the function loaded in the memory won't update. You need to reload it, using reload() function in imp module.

>>> import imp>>> imp.reload(test)>>> test.SayHello("Deepak", "Python")Hi Deepak! How are you?Welcome to Python Tutorial by TutorialsPoint

Packages in Python

A package is a hierarchical file directory structure that defines a single Python application environment that consists of modules, subpackages and, sub-subpackages, and so on.

Consider a filePots.py available inPhone directory. This file has following line of source code −

def Pots():   print "I'm Pots Phone"

Similar way, we have another two files having different functions with the same name as above −

• Phone/Isdn.py file having function Isdn()

• Phone/G3.py file having function G3()

Now, create one more file __init__.py inPhone directory −

• Phone/__init__.py

To make all of your functions available when you've imported Phone, you need to put explicit import statements in __init__.py as follows −

from Pots import Potsfrom Isdn import Isdnfrom G3 import G3

After you add these lines to __init__.py, you have all of these classes available when you import the Phone package.

# Now import your Phone Package.import PhonePhone.Pots()Phone.Isdn()Phone.G3()

When the above code is executed, it produces the following result −

I'm Pots PhoneI'm 3G PhoneI'm ISDN Phone

In the above example, we have taken example of a single functions in each file, but you can keep multiple functions in your files. You can also define different Python classes in those files and then you can create your packages out of those classes.