File importing on python project

Question

I want to have following project directory structure in python:

project\
    generic.py
    subdir1\
        file1.py
    subdir2\
        file2.py
    subdir3\
        file3.py

within file1.py I want to import generic.py from a root dir of project.

import generic

Unfortunatelly I got error when a try to execute "file1.py"

root:~/project/sidir1# python file1.py
Traceback (most recent call last):
  File "file1.py", line 7, in <module>
    import generic
ImportError: No module named generic

I want to execute individual file*.py and have generic.py included.

How to correctly include it under such a drirectory structure?

Qwerty · Answer 1 · 2018-11-14T15:42:29.693

1

You can make your python project a package by making __init__.py in the root directory.

You can then use relative imports, ex: from .. import generic

edited Nov 14 '18 at 15:42

answered Nov 14 '18 at 15:07

Qwerty

1,252
1
11
23

I added /__init__.py and within my file1.py did "import ..generic" but still syntax error – user3428154 Nov 14 '18 at 15:40

score 0 · Answer 2 · answered Nov 14 '18 at 15:09

0

Have a Look here: How to import a Python class that is in a directory above? How to import a Python class that is in a directory above?

answered Nov 14 '18 at 15:09

Flow

75
8

using `from .. import generic` I got error _ValueError: Attempted relative import in non-package_ by following the recommendation – user3428154 Nov 14 '18 at 19:43

score 0 · Answer 3 · answered Nov 14 '18 at 15:12

0

It's cause of Python path, when you use import, python will try to find in every directory in sys.path if module with name given exist, if he don't found, he raise.

For fix your problem, just add parent directory to your python path

import sys
sys.path.append("..")

answered Nov 14 '18 at 15:12

iElden

1,272
1
13
26

at which directory should I need to reside when adding sys.path.append("..")? – user3428154 Nov 14 '18 at 15:43
your working dir is not important, it's relative to the directory of the file that is launched – iElden Nov 14 '18 at 15:46

score 0 · Answer 4 · answered Nov 14 '18 at 15:16

I would encourage you to instead wrap generic.py within a package along with the other submodules. Importing from root is usually a good recipe to later needing to debug imports that no longer work the way they should. Relative imports within a package can also become problematic.

Just build a structure like this:

project\
    my_package\
        generic.py
        __init__.py
        subdir1\
            file1.py
            __init__.py
        subdir2\
            file2.py
            __init__.py
        subdir3\
            file3.py
            __init__.py

And now in file*.py do: from my_package import generic

Now on the project level put a main.py or similar script where you use the functions that are available in my_package.

File importing on python project

4 Answers4