Python Examples

Maximum Line Length

Wrong:

print("This is a really, really, really, really, really, really, really, really, really, really long line of code.")

Right:

print("This is a really long line of code "
      "that has been broken into two shorter lines.")

Imports

Wrong:

import os, sys

Right

# Standard library imports
import os
import sys

# Third-party imports
import numpy as np

# Local imports
import my_module

Exceptions

Wrong:

try:
    result = 10 / x
except:
    print("Error: Something went wrong")

Right:

try:
    result = 10 / x
except ZeroDivisionError:
    print("Error: Division by zero")
except Exception as e:
    print("Error:", e)

String formatting

Wrong:

name = "John"
age = 30
formatted_string = "Hello " + name + ", your age is " + str(age)
print(formatted_string)

Right:

name = "John"
age = 30
formatted_string = "Hello %s, your age is %d" % (name, age)
print(formatted_string)

Documentation

Wrong:

def calculate_area(radius):
    # This function calculates the area of a circle
    area = 3.14159 * radius ** 2
    return area

Right:

def calculate_area(radius):
    """
    Calculate the area of a circle.

    :param radius: The radius of the circle.
    :type radius: float
    :return: The area of the circle.
    :rtype: float
    """
    area = 3.14159 * radius ** 2
    return area