Python Naming Conventions Guide

Naming Conventions for Python Variables

Variables:

• Use descriptive names that convey the purpose or content of the variable.
• Follow the snake_case naming convention (lowercase with underscores between words).
• For constants, use all uppercase with underscores.
• Avoid using single-letter variables except in cases like loop counters.

Example:

# Descriptive variable names
customer_name = "John Doe"
total_amount = 100.50

# Constants
PI = 3.14159
MAX_RETRIES = 3

Functions:

• Use verbs or verb phrases for function names to indicate the action performed.
• Follow the snake_case naming convention.
• Make function names concise while being descriptive of the operation.

Example:

def calculate_total_cost(item_prices):
    # Function to calculate total cost

def fetch_data_from_api(endpoint):
    # Function to fetch data from an API

Classes:

• Use CapWords (capitalize the first letter of each word) for class names.
• Use nouns or noun phrases that represent the objects created by the class.
• Ensure that class names are clear and reflect the purpose of the class.

Example:

class Customer:
    # Class representing a customer object

class OrderProcessor:
    # Class to process orders and handle related operations

Following these naming conventions will enhance the readability and maintainability of your Python code, making it easier for others to understand and work with your code effectively.