{"id":5971,"date":"2022-04-23T22:16:43","date_gmt":"2022-04-23T20:16:43","guid":{"rendered":"http:\/\/miro.borodziuk.eu\/?p=5971"},"modified":"2026-01-23T18:30:42","modified_gmt":"2026-01-23T17:30:42","slug":"packages-in-python","status":"publish","type":"post","link":"http:\/\/miro.borodziuk.eu\/index.php\/2022\/04\/23\/packages-in-python\/","title":{"rendered":"Packages in Python"},"content":{"rendered":"

In the world of modules, a package plays a similar role to a folder\/directory in the world of files.<\/p>\n

<\/p>\n

1. While a module is designed to couple together some related entities (functions, variables, constants, etc.), a package is a container which enables the coupling of several related modules under one common name. Such a container can be distributed as-is (as a batch of files deployed in a directory sub-tree) or it can be packed inside a zip file.<\/p>\n

2. During the very first import of the actual module, Python translates its source code into the semi-compiled format stored inside the pyc<\/code> <\/strong>files, and deploys these files into the __pycache__<\/code><\/strong> directory located in the module’s home directory.<\/p>\n

3. If you want to instruct your module’s user that a particular entity should be treated as private (i.e. not to be explicitly used outside the module) you can mark its name with either the _<\/code> <\/strong>or __<\/code> <\/strong>prefix. Don’t forget that this is only a recommendation, not an order.<\/p>\n

4. The names shabang, shebang, hasbang, poundbang, and hashpling describe the digraph written as #!<\/code><\/strong>, used to instruct Unix-like OSs how the Python source file should be launched. This convention has no effect under MS Windows.<\/p>\n

5. If you want convince Python that it should take into account a non-standard package’s directory, its name needs to be inserted\/appended into\/to the import directory list stored in the path<\/code> <\/strong>variable contained in the sys<\/code> <\/strong>module.<\/p>\n

6. A Python file named __init__.py<\/code><\/strong> is implicitly run when a package containing it is subject to import, and is used to initialize a package and\/or its sub-packages (if any). The file may be empty, but must not be absent.<\/p>\n

 <\/p>\n

6. A repository (or repo for short) designed to collect and share free Python code exists and works under the name Python Package Index (PyPI)<\/strong> although it’s also likely that you come across a very niche name The Cheese Shop. The Shop’s website is available at https:\/\/pypi.org\/.<\/p>\n

 <\/p>\n

7. To make use of The Cheese Shop the specialized tool has been created and its name is pip<\/strong> (pip installs packages while pip stands for… ok, don’t mind). As pip may not be deployed as a part of standard Python installation, it is possible that you will need to install it manually. Pip is a console tool.<\/p>\n

 <\/p>\n

8. To check pip’s version one the following commands should be issued:<\/p>\n

pip --version<\/pre>\n
or<\/p>\n
pip3 --version<\/pre>\n
Check yourself which of these works for you in your OS’ environment.<\/p>\n
 <\/p>\n
9. List of main pip activities looks as follows:<\/p>\n
pip help operation<\/code><\/strong> – shows brief pip’s description;
\npip list<\/code> <\/strong>– shows list of currently installed packages;
\npip show package_name<\/code><\/strong> – shows package_name info including package’s dependencies;
\npip search anystring<\/code> <\/strong>– searches through PyPI directories in order to find packages which name contains anystring;
\npip install name<\/code><\/strong> – installs name system-wide (expect problems when you don’t have administrative rights);
\npip install<\/code>--user name<\/code> <\/strong>– install name for you only; no other your platform’s user will be able to use it;
\npip install -U name<\/code><\/strong> – updates previously installed package;
\npip uninstall name<\/strong><\/code> – uninstalls previously installed package;<\/p>\n
 <\/p>\n
 <\/p>\n
Exercise 1<\/em><\/p>\n
You want to prevent your module’s user from running your code as an ordinary script. How will you achieve such an effect?<\/p>\n
import sys\r\n\r\nif __name__ == \"__main__\":\r\n  print \"Don't do that!\"\r\n  sys.exit()<\/pre>\n
 <\/p>\n
Exercise 2<\/em><\/p>\n
Some additional and necessary packages are stored inside the D:\\Python\\Project\\Modules<\/code><\/strong> directory. Write a code ensuring that the directory is traversed by Python in order to find all requested modules.<\/p>\n
import sys\r\n\r\n# note the double backslashes!\r\nsys.path.append(\"D:\\\\Python\\\\Project\\\\Modules\")<\/pre>\n
 <\/p>\n
Exercise 3<\/em><\/p>\n
The directory mentioned in the previous exercise contains a sub-tree of the following structure:<\/p>\n
abc\r\n|__ def\r\n|__ mymodule.py<\/pre>\n
Assuming that D:\\Python\\Project\\Modules<\/code><\/strong> has been successfully appended to the sys.path<\/code><\/strong> list, write an import directive letting you use all the mymodule entities.<\/p>\n
 <\/p>\n
import abc.def.mymodule<\/pre>\n
 <\/p>\n
Exercise 4<\/em><\/p>\n
Where does the name “The Cheese Shop” come from?<\/p>\n
It’s a reference to an old Monty Python’s sketch of the same name.<\/p>\n
 <\/p>\n
Exercise 5<\/em><\/p>\n
Why should I ensure which one of pip and pip3 works for me?<\/p>\n
When Python 2 and Python 3 coexist in your OS, it’s likely that pip identifies the instance of pip working with Python 2 packages only.<\/p>\n
 <\/p>\n
Exercise 6<\/em><\/p>\n
How can I determine if my pip works with either Python 2 or Python 3?<\/p>\n
pip --version<\/pre>\n
will tell you that.<\/p>\n
 <\/p>\n
Exercise 7<\/em><\/p>\n
Unfortunately, I don’t have administrative right. What should I do to install a package system-wide?<\/p>\n
You have to ask your sysadmin – don’t try to hack your OS!<\/p>\n
 <\/p>\n
Ex. 8<\/p>\n
You have installed a Python package to edit videos. The package is structured as follows:<\/p>\n
    editor\r\n        |________videos\r\n        |        |______videoproc.py\r\n        |        |______videoedit.py\r\n        |\r\n        |________sounds\r\n                    |____fx\r\n                          |____fx1.py\r\n                          |____fx2.py<\/pre>\n
\n
You want to use the function editfx()<\/code>\u00a0 from the fx1<\/code>\u00a0 module ; you also want to rename the function editfx()<\/code> as editsound()<\/code> because you already have defined a function\u00a0 editfx()<\/code> in your program.<\/p>\n
Which of the code below will achieve these requirements ?<\/p>\n<\/div>\n
\n
\n
\n
\n
\n
A: import editor.sounds.fx.fx1.editfx as editsound<\/code><\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
B: from editor.sounds.fx.fx1 import editfx as editsound<\/code><\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
\n
C: from fx1 import editfx as editsound<\/code><\/p>\n
D:<\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
\n
\n
\n
import editor.sounds.fx.fx1\r\nrename editfx as editsound<\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
 <\/p>\n
Explanation:<\/p>\n
When importing a module from a package that has multiple subpackages (subfolders), you need to indicate the “path” of the module in the import statement, starting from the “root” package all the way to the actual module name.<\/p>\n
In the case of the above package, importing any functions from the fx1<\/code> module would be done as follow:<\/p>\n
import editor.sounds.fx.fx1<\/code>\u00a0 -> this would import all the functions, methods, etc. from the fx1<\/code> module.<\/p>\n
To import a specific function (for example editfx()<\/code>) from the fx1<\/code> module, you would use the following command :<\/p>\n
from editor.sounds.fx.fx1 import editfx<\/code>\u00a0 -> this would import the editfx()<\/code> function from the fx1<\/code> module.<\/p>\n
To rename a function when importing it, you can use the as<\/code> keyword :<\/p>\n
from editor.sounds.fx.fx1 import editfx as editsound<\/code>\u00a0 \u00a0-> this is the correct answer.<\/p>\n
B.<\/p>\n<\/div>\n
 <\/p>\n
Ex. 9<\/p>\n
\n
You have stored multiple Python modules in folder :<\/p>\n
 C:\\Users\\luke\\Documents\\My_modules<\/em><\/code> (on a Windows Operating System). You want those modules to be available for import in a Python script you are creating.<\/p>\n
Which code snippet below will achieve this ?<\/p>\n<\/div>\n
\n
\n
\n
A.<\/div>\n
\n
\n
\n
\n
from sys import path\r\npath.append('C:\\\\Users\\\\luke\\\\Documents\\\\My_modules')<\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
B.<\/span><\/div>\n
\n
\n
\n
\n
import sys\r\nsys.path.append('C:\\Users\\luke\\Documents\\My_modules')<\/pre>\n
C.<\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
\n
\n
\n
import os\r\nos.path.append('C:\\\\Users\\\\luke\\\\Documents\\\\My_modules')<\/pre>\n
D.<\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
\n
\n
\n
import os\r\nos.path.append('C:\\Users\\luke\\Documents\\My_modules')<\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
Explanation:<\/p>\n
When importing a module, Python will search for those modules in all folders defined in the path <\/code>variable. That variable can be read or modified using the sys <\/code>module.<\/p>\n
In addition, because \\<\/code> is a special character, an escape character (\\<\/code>) must be use to represent it in a string – in other words : \\\\<\/code><\/p>\n
So, the only valid answer is A :<\/p>\n
\n
\n
from sys import path\r\npath.append('C:\\\\Users\\\\luke\\\\Documents\\\\My_modules')<\/pre>\n<\/div>\n
 <\/p>\n
Ex. 10<\/p>\n
\n
You have been provided with a new Python module file moduleABC.py<\/code> which you placed in folder C:\\MyModules<\/code> on your computer (Operating System is Windows).<\/p>\n
You have written a code snippet which uses this module (you have included import moduleABC<\/code> in your code). However, when you run your program, you receive a ModuleNotFoundError<\/code> exception.<\/p>\n
How can you resolve this issue and clear this exception ?<\/p>\n<\/div>\n
\n
\n
\n
\n
\n
A. Add the folder C:\\MyModules<\/code>\u00a0 in the __init__.py <\/code> file, which will instruct Python on where to find the new module.<\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
\n
B. Move the file moduleABC.py<\/code>\u00a0 in the __pycache__<\/code> directory.<\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
\n
C. Use pip <\/em>to install the module which will place the file in the correct folder.<\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
\n
D. Update the sys.path<\/code> list with folder C:\\MyModules<\/code>.<\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
<\/div>\n