If you're inside a directory that contains any _init_.py it's a directory composed of modules, not files.

🏷️ How to name filesįirst of all, in Python there are no such things as 'files' and I noticed this is the main source of confusion for beginners. We're going to discuss how to solve this soon in this chapter. We need to set up the project to be installed under this repository.

The only drawback of doing it is that you can't import module_a in your python code out of the box. The main reason behind the src dir is to keep active project code concentrated inside a single directory while settings, CI/CD setup, and project metadata can reside outside of it. It's boring to have things so apart due to the alphabetical sorting of the IDE. This is quite annoying because of the lack of order, producing things like (example): non_recommended_project Some variations include no src dir with all project modules around the tree.

I've seen many projects doing differently. If in doubt, consider what people would pip install and how you would like to import module.įrequently it has the same name as the top project. I recommend you to keep all your module files inside a src dir, and all tests living side by side with it: Let's focus first on directory structure, file naming, and module organization. This is not necessarily bad if you know what you're doing.ĭuring this chapter, I'm going to present to you guidelines that worked for me over the past working in different companies and with many different people.

Many decisions that are easy to implement may backfire producing code that is extremely hard to maintain. Do you need to modify a function behavior? Why not a decorator!?.Do you need to read an os environment var? Just read it right there.Do you want to keep all project classes in a single main.py file? Yes, it works.So far Python is one of the most flexible languages I had contact with and everything too flexible enhances the odds of bad decisions. Python is different from languages like C# or Java where they enforce you to have classes named after the file they live in. 🐍 Python For every minute spent in organizing, an hour is earned.

Writing code in python