Python Code Structure Essentials

Understanding Python Code Structure

1. Basic Structure

A Python program is a sequence of instructions and statements that perform specific tasks. Here's a simple breakdown of how Python code is structured:

1. Comments: Used to explain parts of the code. Comments are ignored by the interpreter.
2. Imports: Statements that bring in external modules or libraries.
3. Functions: Blocks of reusable code that perform a specific task.
4. Classes: Blueprints for creating objects (more complex structures than functions).
5. Main Code: The main part of the script that executes when the program runs.

2. Detailed Breakdown

Comments

• Single-line comment: Start with #.
• Multi-line comment: Enclosed in triple quotes (''' or """).

# This is a single-line comment
'''
This is a
multi-line comment
'''

Imports

• Used to include external libraries.

import math  # Imports the math library
from datetime import datetime  # Imports only the datetime class from datetime module

Functions

• Defined using the def keyword followed by a function name and parentheses ().

def greet(name):
    # Function to print a greeting
    print(f"Hello, {name}")

Classes

• Defined using the class keyword. Classes contain methods (functions) and properties.

class Dog:
    # Class attribute
    species = "Canis familiaris"

    # Initializer / Instance attributes
    def __init__(self, name, age):
        self.name = name
        self.age = age

    # Method
    def bark(self):
        print(f"{self.name} says woof!")

# Creating an instance of the Dog class
my_dog = Dog(name="Buddy", age=5)
my_dog.bark()  # Output: Buddy says woof!

Main Code Execution

• The main code often includes an if __name__ == "__main__": block to ensure it runs only when the script is executed directly.

def main():
    greet("Alice")
    print("This is the main function.")

if __name__ == "__main__":
    main()  # This will call the main() function when the script is run directly

Summary

• Comments: Explain the code; not executed.
• Imports: Bring in libraries/modules.
• Functions: Reusable blocks of code.
• Classes: Blueprints for objects; contain methods and properties.
• Main Code: The part that executes when the program runs.

For further learning, consider structured courses on the Enterprise DNA Platform.