Python imports in nested structure

Question

There is the following structure:

project/
   I-----main.py
   I-----src/
          I----__init__.py (empty)
          I----util.py
          I----shared/
                  I----__init__.py (empty)
                  I----hello.py 


#main.py
from src import util

#util.py (runs without errors)
from shared import hello

#hello.py (runs without errors)
def hello():
    print("Hello")

I try to run main.py, get result

ModuleNotFoundError: No module named 'shared'

How to repair imports in main.py?

Why are there two __init__.pys? Please check stackoverflow.com/questions/2164258/… — new Q Open Wid
– new Q Open Wid, Commented May 21, 2021 at 11:53
@newQOpenGLWidget one __init__.py per package, that looks correct to me. __init__.py is not a constructor. — SuperStormer
– SuperStormer, Commented May 21, 2021 at 11:55

Jeremy Caney · Accepted Answer · 2021-05-21 18:59:31Z

2

There are two main reasons for such kind of failures:

Module import: You are not importing the module correctly. You can either import it using the __init__.py of a module by mentioning the import of its sub-module or you can directly put the full path via an import. For instance, you can use from src.shared import hello. Or, in your __init__.py file, inside the src module, you could add from shared import hello. This will also work because whenever you import a module, the first thing that is being run in that module is the __init__.py of that file.
Circular imports: This is not your case, but I am bringing this up because many times we ignore this and get trapped. A circular import occurs when two modules depend on each other. I have described why it happens and how to avoid it in the post, What is Circular Import and how to avoid it.

edited May 21, 2021 at 18:59

Jeremy Caney

7,808114 gold badges57 silver badges86 bronze badges

answered May 21, 2021 at 12:06

Pratap Alok Raj

1,21612 silver badges20 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

DSteman · Accepted Answer · 2021-05-21 11:53:12Z

1

You probably want to from src.shared import hello

answered May 21, 2021 at 11:53

DSteman

1,7145 gold badges15 silver badges36 bronze badges

3 Comments

mufazmi Over a year ago

This does not provide an answer to the question. To critique or request clarification from an author, leave a comment below their post. - From Review

Jeremy Caney Over a year ago

@mufazmi: This one does provide an answer. That said, subsequently contributed answers reiterate this suggestion but with a lot more detail.

kostya Over a year ago

it isnt a stable and always working solution

kostya · Accepted Answer · 2021-05-24 07:55:32Z

0

i found possible solution (works well):


    #util.py
    import sys
    from pathlib import Path
    
    root = Path(__file__).parent.parent #depends on file's place in general structure
    sys.path.append(str(root))
    import src.shared.hello as hello

answered May 24, 2021 at 7:55

kostya

272 silver badges8 bronze badges

Comments

SuperStormer · Accepted Answer · 2021-05-21 12:02:32Z

-1

You need to use a relative import:

from .shared import hello

If you run util.py normally, .../project/src is appended to sys.path and Python can find the import. However, when you run main.py, .../project/ is appended to sys.path, and Python can't find the shared module. By using a relative import, Python looks up the module name relative to the current package, and can find the shared module.

See also: Relative imports for the billionth time

answered May 21, 2021 at 12:02

SuperStormer

5,5085 gold badges29 silver badges40 bronze badges

Collectives™ on Stack Overflow

Python imports in nested structure

4 Answers 4

Comments

3 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

3 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related