Following Coding Conventions and Style Guidelines (PEP 8) in Python

Why Follow Coding Conventions?

Coding conventions and style guidelines help maintain consistency in your Python code, making it easier to read and understand by yourself and other developers. By adhering to the guidelines, you create code that is more legible, maintainable, and accessible to a broader audience.

PEP 8 - Python Enhancement Proposal 8:

PEP 8 is the official style guide for Python code. It covers various aspects of coding conventions, including indentation, naming conventions, and code layout. Following PEP 8 can lead to more readable and consistent Python code.

Examples of PEP 8 Guidelines:

• Indentation: Use 4 spaces for indentation. Avoid using tabs.
• Naming Conventions: Use descriptive names for variables, functions, and classes. Use lowercase for variable and function names, and capitalize class names. Separate words with underscores (snake_case).
• Whitespace: Avoid trailing whitespace at the end of lines. Separate functions and classes with two blank lines, and methods within a class with one blank line.
• Line Length: Limit lines to a maximum of 79 characters. For long lines, break them into multiple lines with appropriate indentation.
• Comments: Use comments to explain complex logic or non-obvious code. Maintain a space after the # character.

        
            # Example of following PEP 8 guidelines

            def calculate_sum(a, b):
                # This function calculates the sum of two numbers.
                return a + b

            class MyClass:
                def __init__(self, name):
                    self.name = name

                def greet(self):
                    # Greet the user
                    print("Hello, " + self.name + "!")

            # Create an instance of MyClass and call the greet() method
            obj = MyClass("Alice")
            obj.greet()
        
    

By following PEP 8 and adhering to coding conventions, you contribute to the overall readability and maintainability of Python code, fostering a collaborative and efficient development environment.

pep8.org — The Prettiest Way to View the PEP 8 Python Style Guide YouTube Video