Python: Styling your Code

Photo by Brooke Lark on Unsplash

How should you style your code?

The Zen of Python, by Tim PetersBeautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than *right* now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea -- let's do more of those!

Python Enhancement Proposal (PEP)

Indentation

Don’t mix tab and spaces in your file as it can cause problems that are difficult to figure out.

Line Length

Blank Lines

numbers = []
print("List of numbers:")
for number in range(1, 11):
value = number
numbers.append(value)
#This is a "Blank Line" that separates parts of the program
message = "My favorite number is " + str(numbers[6]) + "!"
print(message)
>>> List of numbers:>>> My favorite number is 7!

As you can see, the comment is there to show an example of where the blank line would be, but in reality there would be no comment there and it would just be an empty space in the code that would separate the creation of the list (from lines one to five) and using the newly created list to produce a message (from lines seven and eight).

The blank lines would not affect how your code runs, but it will affect how readable your code is to yourself and others.

Learning is neat.