Скачать или смотреть How to Import Functions from One Module to Another in Python Without Messing with PYTHONPATH

Discover simple and effective methods to import functions from one module to another in Python, eliminating the need for complex changes to the environment or sys.path.
---
This video is based on the question https://stackoverflow.com/q/62341680/ asked by the user 'Josh Demail' ( https://stackoverflow.com/u/12798923/ ) and on the answer https://stackoverflow.com/a/62341992/ provided by the user 'gelonida' ( https://stackoverflow.com/u/858675/ ) 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 import function

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.
---
How to Import Functions from One Module to Another in Python Without Messing with PYTHONPATH

Efficiently organizing and utilizing code through modules is a crucial aspect of programming in Python. However, many beginners encounter roadblocks when trying to import functions from one module to another, often leading to confusion and frustration. In this guide, we will explore various methods to import functions from utils.py in Module_1 to basic.py in Module_2, addressing the common concern of avoiding modifications to the PYTHONPATH.

Understanding the Problem

Suppose you have a directory structure like this:

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

You may have some useful functions defined in utils.py. The main goal is to use these functions inside basic.py without altering the Python environment significantly. Let us go through some effective strategies to tackle this.

Solution Overview

There are several effective approaches to solve the problem of importing functions from Module_1/utils.py into Module_2/basic.py. I recommend keeping it simple and efficient while maintaining the readability and structure of your code.

Preferred Method 1: Restructuring Your Directory

If it fits your project's context, the easiest method is to restructure your directories slightly:

Move Module_2/basic.py to the parent directory of both Module_1 and Module_2. The new structure would look like this:

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

Create an empty __init__.py file inside Module_1. This will help Python recognize the directory as a module.

Now you can simply import the function inside basic.py:

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

Preferred Method 2: Adding __init__.py Files

If restructuring isn't an option, you can still enable module imports by adding __init__.py files:

Create empty __init__.py files in both Module_1 and Module_2:

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

Now, just use the same import statement in basic.py:

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

Execution Context Considerations

Run the Script Correctly: Instead of running the script directly, you should run it from the parent directory using the following command:

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

Alternatively, if you're using a Unix-like operating system, you can specify the PYTHONPATH while executing the script:

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

Less Preferred Method: Modifying sys.path

While it might seem simpler, adding paths to sys.path directly can lead to complications in larger projects. Here’s how you would do it, though it’s not recommended:

At the beginning of Module_2/basic.py, add the following lines:

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

You can then proceed with the import as initially shown:

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

Conclusion

By organizing your modules properly and using __init__.py files, you can seamlessly import functions across modules in Python. This approach keeps your code clean, maintainable, and easy to manage. Remember to run your scripts from the correct directory to ensure the imports work as expected.

By following these guidelines, you can tackle Python imports with confidence and avoid the pitfalls of changing system paths and environmental variables.

Feel free to drop any questions or comments below!