Package structure and usage in Python - Step-by-Step Execution

Concept Flow - Package structure and usage

Create package folder

↓

Add __init__.py file

↓

Add modules (python files)

↓

Import package/module in main script

↓

Use functions/classes from package

↓

Run main script

This flow shows how to create a package folder with __init__.py, add modules, import them, and use their contents in a main script.

Execution Sample

Python

mypackage/
  __init__.py
  greetings.py

# greetings.py
def say_hello():
    return 'Hello!'

# main.py
from mypackage.greetings import say_hello
output = say_hello()
print(output)

This code creates a package with a greetings module and uses its function in main.py to print a greeting.

Execution Table

Step	Action	File/Module	Result/Output
1	Create folder 'mypackage' and add __init__.py	mypackage/__init__.py	Package recognized by Python
2	Write function say_hello in greetings.py	mypackage/greetings.py	Function say_hello defined
3	Import say_hello from mypackage.greetings in main.py	main.py	say_hello function available
4	output = say_hello()	main.py	output = 'Hello!'
5	print(output)	main.py	Output: Hello!

💡 Program ends after printing the greeting.

Variable Tracker

Variable	Start	After call	Final
say_hello	function defined	called	returned 'Hello!'
output	undefined	'Hello!'	'Hello!'

Key Moments - 3 Insights

Why do we need the __init__.py file in the package folder?

The __init__.py file tells Python this folder is a package, so imports like 'from mypackage.greetings' work. See execution_table step 1.

How does Python find the say_hello function when we import it?

Python looks inside the greetings.py module in the mypackage folder because of the import statement in step 3.

What happens if we forget to call the function before printing?

If we print say_hello without parentheses, it prints the function object, not the string. See step 4 and 5 for correct call.

Visual Quiz - 3 Questions

Look at the execution_table, at which step is the package recognized by Python?

A Step 3

B Step 2

C Step 1

D Step 4

💡 Hint

Check the 'Result/Output' column for when the package is recognized.

According to variable_tracker, what is the value of 'output' after the function call?

A function object

B 'Hello!'

C undefined

D None

💡 Hint

Look at the 'After call' and 'Final' columns for 'output' variable.

If we remove __init__.py from the package folder, what will happen when importing?

A Import will fail because Python won't recognize the folder as a package

B Import will work normally

C Function will return None

D Python will run the function automatically

💡 Hint

Refer to key_moments about the role of __init__.py and execution_table step 1.

Concept Snapshot

Package structure in Python:
- Create a folder for the package
- Add __init__.py file inside (can be empty)
- Add modules (python files) inside the folder
- Import modules/functions using 'from package.module import func'
- Use imported functions/classes in your script
- Run the script to use the package

Full Transcript

To create a Python package, first make a folder and add an __init__.py file inside it. This file tells Python the folder is a package. Then add Python files (modules) with functions or classes. In your main script, import what you need from the package modules. Call the functions and print or use their results. The execution table shows each step: creating the package, defining functions, importing, calling, and printing output. Variables track the function and output values. Key moments explain why __init__.py is needed and how imports work. The quiz tests understanding of these steps and concepts.

Practice

1. What is the main purpose of the __init__.py file in a Python package?

easy

A. To mark a directory as a Python package

B. To execute the main program

C. To store global variables

D. To compile Python files

Solution

1. Step 1: Understand the role of __init__.py

   The __init__.py file tells Python that the directory should be treated as a package.

2. Step 2: Differentiate from other options

   It does not execute the main program, store global variables, or compile files; its main role is package identification.

3. Final Answer:

   To mark a directory as a Python package -> Option A

4. Quick Check:

   __init__.py marks packages [OK]

Hint: Remember: __init__.py makes folder a package [OK]

Common Mistakes:

• Thinking __init__.py runs main code automatically
• Confusing it with a script file
• Assuming it compiles Python files

2. Which of the following is the correct way to import the module utils from a package named mypackage?

easy

A. import mypackage.utils

B. from utils import mypackage

C. import utils.mypackage

D. from mypackage import utils

Solution

1. Step 1: Recall Python import syntax for packages

   To import a module from a package, use from package_name import module.

2. Step 2: Match syntax to options

   from mypackage import utils matches this syntax: from mypackage import utils.

3. Final Answer:

   from mypackage import utils -> Option D

4. Quick Check:

   Import module with 'from package import module' [OK]

Hint: Use 'from package import module' to import modules [OK]

Common Mistakes:

• Reversing package and module names
• Using incorrect import order
• Trying to import module as package

3. Given this package structure:

mypackage/
  __init__.py
  math_ops.py
  string_ops.py

And this code:

from mypackage import math_ops
print(math_ops.add(2, 3))

If math_ops.py contains a function def add(a, b): return a + b, what is the output?

medium

A. None

B. TypeError

C. 5

D. NameError

Solution

1. Step 1: Understand the import and function call

   The code imports math_ops from mypackage and calls math_ops.add(2, 3).

2. Step 2: Evaluate the function output

   The function add returns the sum of 2 and 3, which is 5.

3. Final Answer:

   5 -> Option C

4. Quick Check:

   2 + 3 = 5 [OK]

Hint: Trace function call and return value carefully [OK]

Common Mistakes:

• Forgetting to call the function with parentheses
• Confusing module and function names
• Assuming import fails without __init__.py content

4. You have a package folder named tools with modules calc.py and format.py. You try to run:

from tools import calc
print(calc.multiply(4, 5))

But get ModuleNotFoundError. What is the most likely cause?

medium

A. Function multiply does not exist in calc.py

B. Missing __init__.py file in the tools folder

C. Syntax error in import statement

D. Python version is too old

Solution

1. Step 1: Understand ModuleNotFoundError cause

   This error often means Python does not recognize the folder as a package.

2. Step 2: Check package structure requirements

   Without __init__.py, Python won't treat 'tools' as a package, causing import failure.

3. Final Answer:

   Missing __init__.py file in the tools folder -> Option B

4. Quick Check:

   __init__.py missing causes ModuleNotFoundError [OK]

Hint: Always add __init__.py to package folders [OK]

Common Mistakes:

• Assuming function absence causes ModuleNotFoundError
• Ignoring package folder structure
• Blaming Python version without checking files

5. You want to create a package datautils with submodules clean.py and transform.py. You want users to import clean_data function directly from datautils like this:

from datautils import clean_data

Which code should you add to datautils/__init__.py to enable this?

hard

A. from .clean import clean_data

B. import clean_data from clean

C. from clean import clean_data

D. import clean.clean_data

Solution

1. Step 1: Understand relative imports in packages

   Inside __init__.py, use relative import with dot: from .clean import clean_data.

2. Step 2: Confirm correct syntax for exposing functions

   This syntax makes clean_data available directly from datautils.

3. Final Answer:

   from .clean import clean_data -> Option A

4. Quick Check:

   Use 'from .module import func' in __init__.py [OK]

Hint: Use relative import with dot in __init__.py [OK]

Common Mistakes:

• Using absolute import without dot inside __init__.py
• Wrong import syntax like 'import clean_data from clean'
• Trying to import without __init__.py setup