Structuring Python Programs

In this tutorial, we are going to see some best practices for structuring Python programs. Following these conventions makes your code more readable and maintainable.

Use Consistent Indentation

Python uses indentation to define code blocks. Use 4 spaces per indentation level as recommended by PEP 8. Avoid mixing tabs and spaces ?

def calculate_area(length, width):
    # 4 spaces for indentation
    if length > 0 and width > 0:
        area = length * width
        return area
    else:
        return 0

result = calculate_area(5, 3)
print(f"Area: {result}")

Area: 15

Keep Lines Under 79 Characters

Long lines reduce readability. Break long lines using parentheses or backslash continuation ?

Using Parentheses (Recommended)

# Long mathematical expression
def evaluate(a, b, c, d):
    result = ((2 ** (a + b)) / ((c // d) ** d) + a - d * b
              - (3 ** (a + b)) / ((c // d) ** d) + a - d * b)
    return result

print(evaluate(2, 3, 4, 2))

-30.5

Multiple Conditions

a, b, c, d, e, f, g = 1, 2, 3, 4, 5, 6, 7

# Method 1: Using parentheses
if (a + b > c + d and
    c + d > e + f and
    f + g > a + b):
    print('Condition met using parentheses')

# Method 2: Using backslash
if a + b > c + d and \
   c + d > e + f and \
   f + g > a + b:
    print('Condition met using backslash')

Condition met using backslash

Using Docstrings

Docstrings document your functions and classes. Use triple quotes and place them immediately after the definition ?

def calculate_interest(principal, rate, time):
    """
    Calculate simple interest.
    
    Args:
        principal (float): The principal amount
        rate (float): Interest rate per year
        time (int): Time period in years
        
    Returns:
        float: The calculated interest
    """
    return (principal * rate * time) / 100

class BankAccount:
    """
    A simple bank account class.
    
    This class represents a basic bank account
    with deposit and withdrawal functionality.
    """
    
    def __init__(self, balance=0):
        self.balance = balance
    
    def deposit(self, amount):
        """Add money to the account."""
        self.balance += amount

# Test the functions
interest = calculate_interest(1000, 5, 2)
print(f"Simple Interest: {interest}")

account = BankAccount(100)
account.deposit(50)
print(f"Account Balance: {account.balance}")

Simple Interest: 100.0
Account Balance: 150

Additional Best Practices

Conclusion

Following these Python structuring practices improves code readability and maintainability. Use 4-space indentation, keep lines under 79 characters, and always include descriptive docstrings for your functions and classes.