Package import works in Python Interactive window (in VSCode) but not in terminal-run python?

Question

I have a custom Python package (my_package) located in a directory (super_dir). I have a script (my_script.py) in a nested directory of super_dir (let's call it sub_dir) that imports my_package and uses it.

I receive a ModuleNotFound error if I run the script from a terminal window (where my working directory is super_dir) by calling python sub_dir/my_script.py. It does work, however, if my_script.py is located within super_dir, rather than within sub_dir and I simply call python my_script.py. It also works if I run my_script.py in VSCode in the Python Interactive window (even if I'm my working directory is sub_dir) as long as I have the lines

import os
os.chdir('....further_paths/super_dir/')

at the top of the script.

My question is: how can I get the script to run from the terminal such that it can remain within sub_dir but will still be able to import my_package, even though my_package is located 'up' a whole directory?

Even if the lines^ above (that change the current directory) are included at the top of the script, I still get the ModuleNotFound error as long as I run the script from a terminal window and my_script.py is not located in super_dir.

Thank you in advance, I hope my question was clear!

So you have the layout of super_dir/my_package.py and super_dir/sub_dir/my_script.py? — Brett Cannon
– Brett Cannon, Commented Apr 9, 2020 at 21:37
Yes exactly -- except that it's really super_dir/my_package/init.py and super_dir/my_package/my_functions.py since there are modules and .py files within the overarching my_package — Conor
– Conor, Commented Apr 10, 2020 at 10:46

Brett Cannon · Accepted Answer · 2020-04-15 23:13:20Z

3

You have two options. One is you need to set PYTHONPATH to super_dir so that when Python executes your script it looks there for packages during import.

The other option is to make my_script a module and you use python -m sub_dir.my_script to execute the code.

answered Apr 15, 2020 at 23:13

Brett Cannon

16.4k3 gold badges54 silver badges47 bronze badges

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

1 Comment

Conor Over a year ago

Thank you for the clarification! Much appreciated

Johan · Accepted Answer · 2023-05-12 20:00:19Z

0

As long as the script.py you would like to import is not in a parent directory one solution is to make sure (or set) the current working directory for importing script in child directorys to work: import child-dir.script or from child-dir import script.

answered May 12, 2023 at 20:00

Johan

2263 silver badges18 bronze badges

Collectives™ on Stack Overflow

Package import works in Python Interactive window (in VSCode) but not in terminal-run python?

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related