Fix Python Relative Imports and Auto-completion in VSCode

In this video, you will learn how to properly handle Python relative imports without extending the sys.path. Additionally, you will learn how to enable auto-completion for Python packages in Visual Studio Code.
⏬ Get my FREE Python Cheat Sheets: k0nze.gumroad.com
👉 Website Article for this Video: k0nze.dev/posts/python-relati...
💌 Support me on Patreon: / k0nze
☕️ Buy me Coffee: www.buymeacoffee.com/k0nze
🌍 Check out my Website: k0nze.dev
💻 Join our Discord: discord.k0nze.dev
👔 Follow me on LinkedIn: linkedin.k0nze.dev
Recording Gear
Camera - Sony A6400: geni.us/zRw1
Lens - Viltrox AF 23mm f1.4: geni.us/RVrguGd
Microphone - Rode Wireless Go: geni.us/RBAOIx
Keyboard - Keychron K2 v2: geni.us/DPK87Xn
⏰ Timestamps:
0:00 Intro
0:21 Manually Extending the Python sys.path
2:07 Add relative Python imports in VSCode (extending the PYTHONPATH)
3:05 What is the PYTHONPATH?
4:04 Add own Python Packages to VSCode Auto-completion
5:57 Outro

[@k0nze_builds]

Download FREE Python Cheat Sheets: k0nze.gumroad.com

[@MultiMediaUploads]

This is a suboptimal solution that works locally, and forces anyone that works on this project to use vscode as their IDE. The best solution is to package the extern directory as its own package and have it part of the requirements for the project, and then you can import it from there. Unfortunately, you are trying to fix an anti-pattern by promoting another one.

[@victorialopez471]

how would you do that? do you have a video or any reference link?

[@ananthmahadevan2586]

I agree with this comment. Personally I am guilty of using the anti-pattern of extending the system.path. I remember having issues with relative imports if I wanted to start an interactive VSCode sessions a if I wanted to run the module via command line. I also agree that maybe the best way to separately package the external dependencies and then import. I would also be interested in how to do this efficiently and at what stage of development I should do it.

[@rvoros]

For the intellisense part I agree. But the basic problem is not solved with imports because the solution is restricted to VS Code. The script will still not work from command prompt so the antipattern issue is not resolved by this. Path has to be extended... Bad, I agree. If there's a PEP against it they shouldn't only ban it but offer an acceptable solution too.

Doing multiple settings just to help VS Code and nothing else? I think it is much better to turn extern into a proper package and install it using pip (could be an "editable" install for easier development) then it will work everywhere, not just in VS Code.

[@lanceb247Upload]

❤❤❤ You, sir, are awesome. I’ve been googling how to get my VScode debugger working properly with my project for hours now. Yours was the first to give me a pretty clear understanding of what was happening and how to resolve the issue. (I have my project’s main module 2 layers deep). Thank you!!!!

[@JoseLuisNaranjoVillotaEc]

Hello, thanks for the explanations, one additional question: I have classes2.py in the extern directory, if my classses.py have a line: from Dexter import classes2 , then it's not found, the solution that you show us, adding the launch.json only recognizes the classes.py but not the other, how can i solve it?

[@sokolovl]

This helped me a lot working with micropython too (as I need relative imports with sys.path.append on the controller, but want Intellisense when coding). Thanks!

[@shivakrishna1743]

Do we need to do this everytime we create a project? Is there a way to make vscode automatically add project folder to pythonpath? Thanks!

[@alirezamohammadi9691]

that was great!but I have a question...vs code not showing mysql.connector auto complete suggestions what should I do for that?

[@Apo_0]

Many thanks man, for this amazing video, it took me hours to get rid of this!

[@nex88]

I don't make comments often, but you have a very clear way of explaining things. Keep on creating videos!

[@k0nze_builds]

Thank you Joachim! That means a lot to me!

[@emrekara369]

What if there is more than one main file that I need to debug in the same folder?

[@tarakeshnc7417]

Thanks.. So these files are used in VScode environment.. Is it correct ? If you are running the main.py over a shell, will it work ?

[@timothedavid6477]

thanks for all ! I make an anti pattern during several day and now I can work easly :) thanks for all

[@uncoding_with_raj]

I have this same problem with odoo library import tried settings.json and PYTHONPATH settings but it didnot work for me i still get the same import error. can you please help

[@noufbouf]

Would this solution work if someones else tries to use our project using another IDE, let's say Pycharm?

[@carlosnacher3593]

Thanks for the video! But I still have the problem. Imagine your main.py is a main.ipynb. How do we proceed???! Help please :(

[@AzulonKaiba]

Finallye, this helped with the subfolders an Python modules in VS Code

[@k0nze_builds]

I'm happy the video was helpful for you!

[@oskarhovmllerdinesen317]

Great tutorial! Thanks

[@dharamparkashgarg5358]

Hi I am using Visual Studio 2022 and its very complicated and unable to find solution for same problem. Please help. Even I am unable to find Run & debug icon here.

[@DavidPerez-ee6zl]

Thank you for sharing, Very good Job!

[@alexeymatveev9031]

Thanks for the topic, but didn't work for me....(( I'm trying to make import from a parallel directory and it doesn't work(((

[@lDMCl_DANTE]

I ve´ the same problem... and i tried everithing... the only solution was,, add my folder into .venv/lib folder... but the bad was i cant push to github...

[@ucanhlenguyen7720]

Thanks for the solution, it's very helpful.

[@idelfridesjorgewm1]

Thank you very much, that video helped me a lot.

[@kumarvis01]

helpful , simple to the point ..

[@tapgaze7016]

how for multiple paths please?

[@patite3103]

Great video. But where I know in my case where my_package is? I'm just unable to implement it!

[@MrOiZo95]

Thanks for this !

[@hongdong9434]

Thank you so much, this helped a lot. It was really hard to set it up following the VS Code documentation. You made it so much easier to follow. Thx man.

[@k0nze_builds]

I'm glad I could help you out Hong!

[@mookjais]

Thanks! This worked for me

[@k0nze_builds]

I'm glad this video was helpful for you and you Mookjais!

[@lugaresyplantas7819]

Not working for me :/

[@user-wi3ug7vi2u]

Awesome, thanks

[@nsilver42]

Thank you for this. I was trying to solve this exact problem. My project is using a multi-root workspace, and the ${workspaceFolder} substitution was not working for me with the python.analysis.extraPaths setting. Not sure if it is just an issue with PyLance, or multi-root workspaces. But putting in the relative path "..//MyLib" did work, so that is good. The ${workspaceFolder} substitution does work with the PYTHONPATH launch config setting in a multi-root workspace, so that is good.

[@k0nze_builds]

Thats great to hear Nathan! I'm happy this video was helpful for you.

[@sanketwagh7768]

that was very helpfull thansks a ton

[@JoseHenrique-tz6cr]

Very very clear

[@user-kr4jn4qf5q]

Clean, simple, and beautiful. Really enjoy this tutorial. Thank you :)

[@k0nze_builds]

Thank you! I'm happy you liked the video

[@enrico200165]

totally agree. subscribed immediately, perfect for me (and many others I think)

[@miladiouss]

I've been putting off fixing VS Code auto-completion for years. Thank you my man!

[@urbanwolfgaming4985]

Does this allow me to run my python script outside of vs code?

[@k0nze_builds]

This video is not about running Python outside of VSCode. However, VSCode just calls Python on the command line itself and extends the PYTHONPATH in the background. To run a project with relative imports outside of VSCode you have to manually expand the PYTHONPATH and than call your script as a module.

[@sudarshankoirala2072]

Short and clear explanation .. keep making these sort of videos .. thank you !

[@user-vb5nl4gc4m]

Awesome!!

[@prasenjitgiri919]

Hi Konze, I've been trying to find a solution to no module found and chanced upon your video. First of all thank you for the video, but unfortunately I'm unable to resolve the problem. 1. I have created the similar folder structure and yet the debug/run wont work 2. Will you please confirm if these settings are only applicable for debug? As the settings create a debug profile? How to make something for run? 3. I've also noticed while using pycharm, one can simply select folder as "Source" and it wokrs for both debug as well as run. Will appreciate if you can spend time to help a fellow out. Thank you in advance!

[@k0nze_builds]

The settings are also applicable for "run". The "Source" feature of PyCharm does the same thing, it adds the path to the folder to the PYTHONPATH as shown in the video.

[@lch80123]

Subscribed! Really great video that saves my life!! I have two questions. 1)What if I have multiple modules in the same folders that need the extended python path (or multiple extended python paths), can I just put the name of the second module after the first one? 2) It was fine for me to run the file under VS code and import the module from another directory. However, why did it still complains ModuleNotFoundError when I executed the python file via Terminal?

[@Ales-pz6jq]

It gives you that error because terminal is not vscode, and this video is about fixing vscode. It's nice but i still need to find another and generic solution

[@neilianedles9158]

Thank you!

[@mohamadfawaz4146]

You are great!

[@raghuZanne]

Awesome video. Thank you for calm and great explanation!

[@k0nze_builds]

I'm happy you could help you out and you enjoyed the video!

[@raviprasadmr]

I am new to vscode, and I searched stackoverflow and several other pages to end up getting all the confusing information. I am glad that I found out this channel finally to solve my problems. Thanks much!

[@dharamparkashgarg5358]

Fix Python Absolute Imports and Auto-completion in VSCode, could you please fix this issue as well

[@salarghaffarian4038]

Much appreciated! That was very helpful! Thanks!

[@tayloroc1]

This should just work. I am importing a file from the same folder and VS Code can't figure it out. I can't either, that's why I'm complaining.

[@victorhugocubasbalbuena5274]

unfortunately it didn't work for me :(

[@mikhailkhlyzov6205]

As much as I appreciate the explanation and showcase of doing it inside VSCode, the solution feels a bit off imho. I'd rather use editable install of my sub module inside virtual environment (that I use anyway). Would be IDE agnostic.

[@MenAmongTheRuins77]

fixed it sub

[@ohhluka]

it is not working

[@bar-ni1ux]

Good explaination!

[@user-yp3ir6cy4l]

muy bueno

[@user-fj4ts9jt1p]

Honestly, this issue is very annoying, still present on 2024

[@dooley-ch]

Sorry but this is nonsense! Your entire project is now dependent on the IDE you use and if you were actually working with colleagues they would not be able to work with your project without also using the same editor. If you are using package and the loading mechanism correctly there should be no need to resort to this kind of nonsense. You do people no favors by promoting this kind of stuff.

[@maelstrom254]

This is very bad advice, as it forces you to run scripts in vscode only.

[@hashiruww]

Can't understand why microsoft leave this shit

[@fapdayz]

absolutely thrash solution

[@marquinho1p]

if you are using a virual env and you've installed the package locally - its best to put below in either your workspace settings file - or maybe even your settings.json file "python.analysis.extraPaths": [ "${execPath}" ],