Organizing Our Modules - Learn to program with Python

Editor settings

Show hidden files

Use vim keybindings

General settings

Code execution endpoint:

Organizing Our Modules #

After learning how to create a module in a file within the same directory as our Python script, we may want to organize our code better by creating a module in a folder. This allows us to group related functionality together and avoid cluttering our main code file.

Here are the steps to create a module inside a folder from our previous example:

Create an empty file named greetings/__init__.py. This will create a folder named greetings and a new file __init__.py. The file structure now looks like this:
```
.
├── main.py # Our main file
├── greetings.py
└── greetings # A module folder
    └── __init__.py
```
The __init__.py file is required when you want to treat a directory as a package and import modules from it. When Python imports a package, it looks for the __init__.py file in the directory, and if it's present, it knows that the directory is a package and can be imported. If the __init__.py file is missing, Python will not recognize the directory as a package and will not be able to import modules from it.
In Python 3.3 and later, the __init__.py file is no longer strictly required for a package. However, it's still a good practice to include it, as it makes the package more explicit and easier to understand for other developers.

Create another file named greetings/functions.py, and copy the content of the file greetings.py into the new file we just created.

.
├── main.py # Our main file
├── greetings.py
└── greetings # A module folder
    ├── __init__.py
    └── functions.py

Now that we have both the file greetings.py and the module folder greetings, we need to remove the file greetings.py to avoid naming conflict and to make sure that whenever we import the module with import greetings or from greetings import ..., Python will look inside the folder instead of the greetings.py file. Remove the file by selecting the file, then click x to the right of the file name.
```
.
├── main.py # Our main file
└── greetings # A module folder
    ├── __init__.py
    └── functions.py
```
Now, we can use this module in our Python script by importing it. Update the code in main.py to import and use the greet() function in the new file we created:
```
from greetings.functions import greet

greet("Alice") # Output: Hello Alice!
```
You could also use another import syntax as well
```
from greetings import functions

functions.greet("Alice") # Output: Hello Alice!
```

Exercise #

Follow the instructions in this lesson.

Tests #

A new file greetings/__init__.py is created
A new file greetings/functions.py is created
Copy the function greet() from greetings.py to greetings/functions.py
Remove the file greetings.py
Update the import path in the main.py file
Call the function greet with the name "Alice"

Language

Output will be displayed here

aW1wb3J0IHN5cw0KaW1wb3J0IHJlDQppbXBvcnQganNvbg0KaW1wb3J0IG1hdGgNCmltcG9ydCBvcw0KZnJvbSB1bml0dGVzdC5tb2NrIGltcG9ydCBwYXRjaCwgQU5ZDQoNCnJlc3VsdHMgPSB7fQ0KDQpwYXRjaGVkX3ByaW50ID0gcGF0Y2goJ2J1aWx0aW5zLnByaW50JykNCnBhdGNoZWRfcHJpbnQuc3RhcnQoKQ0KDQp0cnk6DQogICAgbW9kdWxlX2ZpbGVzID0gb3MubGlzdGRpcignZ3JlZXRpbmdzJykNCiAgICBhc3NlcnQgIl9faW5pdF9fLnB5IiBpbiBtb2R1bGVfZmlsZXMNCiAgICByZXN1bHRzWzFdID0gVHJ1ZQ0KZXhjZXB0IEV4Y2VwdGlvbiBhcyBlOg0KICAgIHJlc3VsdHNbMV0gPSBGYWxzZQ0KDQp0cnk6DQogICAgbW9kdWxlX2ZpbGVzID0gb3MubGlzdGRpcignZ3JlZXRpbmdzJykNCiAgICBhc3NlcnQgImZ1bmN0aW9ucy5weSIgaW4gbW9kdWxlX2ZpbGVzDQogICAgcmVzdWx0c1syXSA9IFRydWUNCmV4Y2VwdCBFeGNlcHRpb24gYXMgZToNCiAgICByZXN1bHRzWzJdID0gRmFsc2UNCg0KdHJ5Og0KICAgIGZyb20gZ3JlZXRpbmdzIGltcG9ydCBmdW5jdGlvbnMNCiAgICBhc3NlcnQgY2FsbGFibGUoZnVuY3Rpb25zLmdyZWV0KQ0KICAgIHJlc3VsdHNbM10gPSBUcnVlDQpleGNlcHQgRXhjZXB0aW9uIGFzIGU6DQogICAgcmVzdWx0c1szXSA9IEZhbHNlDQoNCnRyeToNCiAgICBhc3NlcnQgJ2dyZWV0aW5ncy5weScgbm90IGluIG9zLmxpc3RkaXIoKQ0KICAgIHJlc3VsdHNbNF0gPSBUcnVlDQpleGNlcHQgRXhjZXB0aW9uIGFzIGU6DQogICAgcmVzdWx0c1s0XSA9IEZhbHNlDQoNCnRyeToNCiAgICB3aXRoIHBhdGNoKCdncmVldGluZ3MuZnVuY3Rpb25zLmdyZWV0JykgYXMgcGF0Y2hlZF9ncmVldDoNCg0KICAgICAgICB0cnk6DQogICAgICAgICAgICBpbXBvcnQgbWFpbg0KICAgICAgICBleGNlcHQgRXhjZXB0aW9uIGFzIGU6DQogICAgICAgICAgICBwYXNzDQoNCiAgICAgICAgdHJ5Og0KICAgICAgICAgICAgYXNzZXJ0IG1haW4uZnVuY3Rpb25zID09IGZ1bmN0aW9ucw0KICAgICAgICAgICAgcmVzdWx0c1s1XSA9IFRydWUNCiAgICAgICAgZXhjZXB0IEV4Y2VwdGlvbiBhcyBlOg0KICAgICAgICAgICAgcmVzdWx0c1s1XSA9IEZhbHNlDQogICAgICAgIA0KICAgICAgICBpZiByZXN1bHRzWzVdIGlzIEZhbHNlOg0KICAgICAgICAgICAgdHJ5Og0KICAgICAgICAgICAgICAgIGFzc2VydCBtYWluLmdyZWV0ID09IGZ1bmN0aW9ucy5ncmVldA0KICAgICAgICAgICAgICAgIHJlc3VsdHNbNV0gPSBUcnVlDQogICAgICAgICAgICBleGNlcHQgRXhjZXB0aW9uIGFzIGU6DQogICAgICAgICAgICAgICAgcmVzdWx0c1s1XSA9IEZhbHNlDQogICAgICAgIA0KICAgICAgICB0cnk6DQogICAgICAgICAgICBwYXRjaGVkX2dyZWV0LmFzc2VydF9jYWxsZWRfd2l0aCgiQWxpY2UiKQ0KICAgICAgICAgICAgcmVzdWx0c1s2XSA9IFRydWUNCiAgICAgICAgZXhjZXB0IEV4Y2VwdGlvbiBhcyBlOg0KICAgICAgICAgICAgcmVzdWx0c1s2XSA9IEZhbHNlDQoNCmV4Y2VwdCBFeGNlcHRpb24gYXMgZToNCiAgICByZXN1bHRzWzVdID0gRmFsc2UNCiAgICByZXN1bHRzWzZdID0gRmFsc2UNCg0KICAgICAgICANCg0Kc3lzLnN0ZG91dC53cml0ZShqc29uLmR1bXBzKHJlc3VsdHMpKQ==