Contribute Media
A thank you to everyone who makes this possible: Read More

Writing Beautiful Code

Translations: en


Writing code is hard. Writing beautiful code is even more so.

How to write code that is pleasant to read, easy to understand and joy to maintain?

Simple things like using right variable names, avoiding to much nesting, using white space and comments etc. makes a lot difference to readability of the code. Even though these things look very simple, it is very hard to put them in practice.

In this talk, I’ll try summarise the age old wisdom of writing beautiful code using python examples.

Choose meaningful variable names
Avoid generic names
Give names to magic numbers
Avoid too many nested levels
Avoid too many branches
Use “telephone test” for readability
Use idioms of the language
Avoid superficial comments
Add comments to explain complex piece of software
Avoid writing comments by writing code clearly
Avoid side effects
Try to make functions stateless
Let one function do one thing well
Write smaller functions - the 7 plus or minus 2 rule
Separate “what” from “how”
Don’t sacrifice clarity for efficiency
The Zen of Python


Improve this page