Скачать или смотреть How to Import Modules from Parent Folder in Jupyter Notebook Using Python

Struggling to import a module from a parent folder in your Jupyter Notebook? Discover effective solutions and understand common pitfalls in our detailed guide.
---
This video is based on the question https://stackoverflow.com/q/64561637/ asked by the user 'Gerardo Zinno' ( https://stackoverflow.com/u/11579184/ ) and on the answer https://stackoverflow.com/a/64562179/ provided by the user 'FinleyGibson' ( https://stackoverflow.com/u/10111013/ ) 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: Can't import module situated in parent folder from Jupyter-lab notebook and pathlib.Path

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.
---
Importing Modules from a Parent Folder in Jupyter Notebook: A Complete Guide

When working with Jupyter Notebooks, managing files and libraries can sometimes become tricky, especially when you're trying to import a module located in a parent folder. This issue is commonly faced by many developers and can lead to frustrating errors like ModuleNotFoundError. In this guide, we will explore a specific scenario where this problem occurs and how to effectively resolve it.

The Scenario

Imagine you have the following folder structure:

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

In this structure, you want to share code between notebookA.ipynb and notebookB.ipynb through a custom library called mylib. However, when you attempt to import mylib using the code below:

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

You encounter an error:

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

Understanding the Problem

The error you're experiencing stems from the fact that you are appending a directory path to sys.path that points to a location inside the mylib folder, rather than the parent directory itself. In Python, when you add a path to sys.path, it instructs the interpreter to look for modules within that specified directory.

Issues with Previous Approaches:

Incorrect Path Addition: By using os.path.join(Path.cwd().parent, 'mylib'), you directed Python to look for mylib paths that exist within the mylib directory.

Pathlib Conversion: The Path.cwd().parent returns a pathlib.PosixPath object. Python may not interpret this correctly without converting it to a string for use in imports.

The Solution

To solve the problem, follow the steps outlined below:

Step 1: Correctly Add the Module Path

You need to append the parent folder directly to sys.path, allowing Python to recognize where mylib actually resides.

Here's the adjusted code:

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

Step 2: Utilizing the Module

Once you have successfully imported the library, you can access the variables and functions defined within:

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

Step 3: Verify Successful Import

You should be able to print a variable defined in otherfiles.py, such as:

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

The output would be:

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

Conclusion

Importing modules from a parent folder in Jupyter Notebooks can be straightforward when you know how to adjust the system path correctly. By appending the parent directory directly to sys.path, you can seamlessly access shared libraries and code across multiple notebooks.

Remember, the key takeaway is to ensure you're pointing to the correct directory, and always convert pathlib.Path objects to strings when necessary!

Now, you're equipped to resolve the ImportError in Jupyter Notebooks and streamline your development workflow effectively.