Скачать или смотреть Resolving the NameError in Python: Importing Scripts from Sibling Directories

Discover solutions to the `NameError` you encounter when importing functions from sibling directories in Python. Learn effective coding practices and directory structuring for seamless imports!
---
This video is based on the question https://stackoverflow.com/q/71270723/ asked by the user 'rahulpareekyx' ( https://stackoverflow.com/u/17668182/ ) and on the answer https://stackoverflow.com/a/71270831/ provided by the user 'Benjamin McKay' ( https://stackoverflow.com/u/10515005/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Python Name Error during importing function from sibling directiry

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Understanding Name Error in Python Imports

When you're working on a Python project that is part of a larger structure, you may run into issues while trying to import functions from sibling directories. A common error encountered is the NameError, which arises when the Python interpreter cannot find a name.

In this guide, we’ll explore a specific scenario where someone faced this issue while attempting to use functions and classes defined in files located in sibling directories. We’ll break down the solution into clear steps to help you avoid the same pitfalls.

The Problem: NameError during Import

Imagine you have the following directory structure:

[[See Video to Reveal this Text or Code Snippet]]

Within the driver.py script located in the Scripts directory, you try to import everything from the utils directory using:

[[See Video to Reveal this Text or Code Snippet]]

However, when you attempt to call a function from common.py—say, load_config(filepath)—you may encounter the error:

[[See Video to Reveal this Text or Code Snippet]]

This raises the question: How can you properly import functions from sibling directories to avoid such errors?

The Solution: A Step-By-Step Guide

To resolve the NameError, follow these steps to properly set up your imports.

Step 1: Use init.py

Create an __init__.py file:

Within your utils folder, create a file named __init__.py.

This special file allows Python to treat the directory as a package, enabling the use of module imports properly.

Define the modules to be imported:

In your __init__.py, you can specify which modules to include when using an import statement. For example:

[[See Video to Reveal this Text or Code Snippet]]

By including the above line, you specify that Python should import the common and helper modules when you use from utils import *.

Step 2: Import Functions Explicitly

Even after adding the __init__.py setup, you still need to be explicit when calling functions from the imported modules in driver.py. For instance:

[[See Video to Reveal this Text or Code Snippet]]

Step 3: Ensure Proper Function Calls

If common.py also imports classes or functions from helper.py, you’ll still refer to them in a similar manner.

Example: If common.py uses a class from helper.py, you will need to access it as follows:

[[See Video to Reveal this Text or Code Snippet]]

Conclusion

Using an __init__.py file and explicitly importing modules provides a simple yet effective solution to the NameError you encounter when trying to import functions from sibling directories in Python. By carefully structuring your imports and using the proper Python package management features, you can streamline your code and make it much easier to manage.

With these tools, you'll avoid the common pitfalls and keep your project organized and functional. Happy coding!