Lay Out Your Code Like You'd Lay Out Your HouseJuly 6, 2018
Imagine you wake up and get up to brush your teeth. You go to the “brooms and brushes” room to get your toothbrush. Then, you go to the “cleaning products” room to get toothpaste. You continue to the “containers” room to get a cup, and finally, you head into the “inputs and outputs” room, where you have a tap that lets water enter your house, and a sink with a drain through which fluids can leave your house. You now have everything to go brush your teeth.
I won’t bore you by describing the rest of your day in this very strange house in detail, but you can imagine getting a knife to spread some peanut butter on your bread from the “cutters” room, where you also keep your razors and garden shears. It’d obviously be incredibly inconvenient of your house were laid out that way. And yet, we often structure our code bases this way.
Why Is This So Inconvenient?
In the example above, you had to visit 4 different rooms just to brush your teeth. This is ridiculous! You’d expect everything you need to brush your teeth to be conveniently located together.
So let’s have a look at an example code base for a hypothetical blogging application. Since it’s a hypothetical code base, I’m not using any specific web/database/… framework here. The code will be written in Python, but you don’t need to know Python to get the point of this post.
The structure of the app might look like this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
BogoBlog/ ├── main.py ├── controllers/ │ ├── posts.py │ ├── comments.py │ └── users.py ├── errors/ │ ├── posts.py │ ├── comments.py │ └── users.py ├── storage/ │ ├── posts.py │ ├── comments.py │ └── users.py ├── templates/ │ ├── posts/ │ │ ├── post.html │ │ └── ... more files ... │ ├── comments/ ...more files inside ... │ └── users/ ...more files inside ... └── validators/ ├── posts.py ├── comments.py └── users.py
This looks like an MVC application. Let’s take a look at the
This code might look reasonable, but there’s a problem when things change. For example, the file above imports functions from manny other modules. If any of these modules changes their public interface, this file needs to be updated. But since the file is not located near the change, you need to search through the entire code base to see where the changed function is called in order to update the calls. For a more concrete example, imagine you are asked to add a “banner_image” field to posts to make them more visually interesting. This required changes in:
storage/posts.pyto add the field to the database.
controllers/posts.pyto handle the uploaded image.
validators/posts.pyto validate the image, make sure it’s of a supported file type, size, etc.
templates/posts/post.htmlto display the image.
While this isn’t too bad in a code base of this size, as your code base grows, it becomes harder to track down where things need to be changed. Having to jump around this much also makes the code base harder to understan. The reason we’re editing files all over the place to add a feature is because we’ve grouped files by what type of code they hold in terms of te MVC pattern, rather than grouping them by what functionality they provide.
Let’s Fix This!
Let’s group all posts-related functionality together, all users-related functionality together, etc…
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
BogoBlog/ ├── main.py ├── posts/ │ ├── controllers.py │ ├── storage.py │ ├── validators.py │ └── templates/ │ ├── post.html │ └── ... more files ... ├── comments/ │ ├── controllers.py │ ├── storage.py │ └── validators.py └── users/ ├── controllers.py ├── storage.py └── validators.py
So now, when we need to change something related to posts, you’ll likely just have to edit files in
/posts, and the same goes for other pieces of functionality. Of course, you may still need to edit code in multiple directories, but at least now you’re thinking in terms of which features of the app a change affects.
When talking about what belongs together in a software project, the word Cohesion is often used. As we all know, Wikipedia is the source of all truth on the internet, so let’s see what Wikipedia has to say about cohesion.
In computer programming, cohesion refers to the degree to which the elements inside a module belong together. In one sense, it is a measure of the strength of relationship between the methods and data of a class and some unifying purpose or concept served by that class. In another sense, it is a measure of the strength of relationship between the class’s methods and data themselves.
Ok, so cohesion just means “how much parts of a program belong together”. The definition of the term doesn’t say anything about how it should be measured, but it is often used without further defining it. People just say you should have “high cohesion”.
Later in the same article, there’s a list of different types of cohesion, defined by how they are measured.
- Functional cohesion is when parts of a module are grouped because they all contribute to a single well-defined task of the module (e.g. Lexical analysis of an XML string).
Studies by various people including Larry Constantine, Edward Yourdon, and Steve McConnell  indicate that […] and functional cohesion is superior.
Functional cohesion sounds a lot like what we just did, right? Grouping things by what functionality they contribute to. So when talking about cohesion, please be specific about what type of cohesion you mean.
I removed a lot of content from this citation because I didn’t feel like citing a whole section from Wikipedia and then re-explaining it. I might spend some more time looking into this, and writing another article about cohesion, because I think this Wikipedia article puts too much emphasis on object-oriented programming, and I’d love to take a look at what cohesion means at diferent levels of granularity and in different programming paradigms.
- It’s not just MVC. I’ve used an MVC app here, because it’s a pattern a lot of people are familiar with, but the same problem occurs in other cases, like when you split a React+Redux app into components, actions, reducers, … etc.
- Conventions are important. You can be much more productive if everyone understands the structure of the code base. If there’s a code base structure that the community, your company or your team sticks to, don’t just suddenly change everything. If you’d like to change the conventions, start a conversation around it. Changing a convention might also require tooling changes, like CLI tools that scaffold the project structure.
- Build frameworks that support this. If you’re the author of a framework, try to design it soo users can structure their code base this way. Django does this quite nicely by splitting projects into “apps” that hold different features for the project. (yes the name app is a bit confusing there, since you’d consider the entire project an app, but you get used to that.)
- Don’t nest too deeply. Directories make it easier to find things, but they have the disadvantage that you need to remember where files are. Most places that display a list of files can do so in alphabetical order based on the file name. And it’s quite easy to find a file in a sorted list, whereas it requires much more mental cycles to remember a deeply nested structure of files and folders.
Thanks for reading!
Please let me know what you think on Twitter