ModuleNotFoundError in a Python project using packages

Question

I have a Python project (python 3.6) with a rather simple package structure. My goal is to have a package containing modules which are reused across other packages. Here is the structure:

    my_project                   
    ├── /docs           
    ├── /src
    │   ├── __init__.py                
    │   ├── /common
    │   |    |── __init__.py      
    │   |    |── common_module.py
    │   ├── /packageA
    │   |    |── __init__.py      
    │   |    |── modA.py

The problem is that when I do the following inside modA.py :

    from src.common import common_module as cm

I get the following error: ModuleNotFoundError: No module named src.common

What I have tried so far is

• making sure I have a correct package structure as in https://docs.python.org/3/tutorial/modules.html
• extending the PYTHONPATH in the virtual environment I am using by export PYTHONPATH=<path_to_project>/src
• placing an __init__.py inside /my_project as well
• read other question on StackOverflow but none of them provided a solution. Some of them were doing hacky stuff with sys.path that was said to not a good solution even if it would work.

None of these worked and I have been struggling with this problem for a while now so any suggestion would be appreciated.

Answer 1

为了使此导入正常进行，PYTHONPATH必须为.../my_project ，而不是.../my_project/src 。

Answer 2

Yes you should put __init__.py in project ,
then export PYTHONPATH = <LOCAL_PATH_TO_...>/project