§2024-12-19

• PEP 8 – Style Guide for Python Code

ChatGPT 4o mini

PEP 8 – Style Guide for Python Code is a document that provides conventions and guidelines to improve the readability and consistency of Python code. It is widely regarded as the standard coding style for Python projects. Below is a summary of the key points:

1. Code Layout

Indentation: Use 4 spaces per indentation level (no tabs). Maximum Line Length: Limit all lines to 79 characters. For docstrings and comments, the limit is 72 characters. Blank Lines: Use blank lines to separate functions, classes, and blocks of code inside functions (2 blank lines between top-level functions, 1 blank line inside methods). Imports: Imports should be on separate lines (e.g., import os and import sys, not import os, sys). Use standard library imports first, followed by third-party imports, and then application-specific imports. Imports should be ordered alphabetically.

2. Naming Conventions

• Variable Names: Use lower_case_with_underscores for functions, variables, and methods.
• Class Names: Use CapitalizedWords for class names (PascalCase).
• Constants: Use ALL_CAPS_WITH_UNDERSCORES for constants.
• Private Variables/Methods: Prefix with a single underscore _ to indicate they are intended for internal use.

3. Comments

• Docstrings: Use docstrings (triple quotes) to describe all public modules, functions, classes, and methods. They should describe the purpose, arguments, and return values clearly.
• Inline Comments: Use them sparingly, and place them on the same line as the code, separated by at least two spaces.
• Block Comments: These should be used for explaining code that might not be immediately clear. Each line should start with a - hash (#), and lines should be wrapped to fit within the 72-character limit.

4. Programming Recommendations

• Avoid Using else After return: In functions, avoid using else after a return statement (it can lead to unnecessary indentation).
• Avoid Using Multiple Statements on One Line: Use one statement per line to enhance clarity.
• Comparisons: Use is or is not when comparing with None, and use == or != for other comparisons.
• Boolean Values: Prefer is for checking boolean conditions (e.g., if x is True: rather than if x == True:).
• Handling Exceptions: Use try/except blocks to handle exceptions. Avoid catching generic exceptions (i.e., except Exception:) unless necessary.

5. Whitespace in Expressions and Statements

Avoid extra spaces in expressions: Don’t add extra spaces around operators unless it improves readability. Correct: x = 1 + 2 Incorrect: x = 1 + 2 Function Arguments: Do not put spaces around the = sign when specifying default values (e.g., def foo(x=42)).

6. Version Compatibility

Python 2/3 Compatibility: Ensure that code is compatible with both Python 2 and Python 3, where possible. However, if targeting Python 3 only, use Python 3-specific features.

7. Other Recommendations

Use of future imports: If writing code that will run on both Python 2 and 3, consider importing features from the future module (e.g., from future import print_function). Avoid Using exec: The use of exec() is discouraged because it can make code harder to understand and debug. Don't Use assert for Data Validation: Assertions should be used only for debugging purposes, not for data validation in production code.

8. Formatting of Documentation

Docstring conventions: Follow the conventions for docstrings (use triple quotes, start with a one-line description, followed by a more detailed explanation if necessary). Sphinx-compatible docstrings: If using Sphinx to generate documentation, consider adhering to Sphinx’s specific markup for docstrings.

ChatGPT 4o mini

Log in

Sign up You said: pep 8 python file directory name ChatGPT said: ChatGPT In PEP 8 (Python's official style guide), it does not explicitly mandate a rule for naming directories that contain Python files. However, it offers guidelines that can be applied to naming conventions for directories in Python projects. These conventions help ensure consistency and maintain readability of your project.

Here are the relevant points from PEP 8 that you can follow for naming directories:

Lowercase Letters with Underscores: Directory names should be written in lowercase letters and can use underscores (_) to improve readability, following the naming convention for modules and packages. For example:

text Copy code my_python_project/ my_module/ utils/ Avoid Using Hyphens: PEP 8 recommends avoiding hyphens (-) in directory names because they can be confusing in code (as they may be interpreted as minus signs), especially when importing packages. Use underscores (_) instead. For example, instead of:

text Copy code my-python-project/ Use:

text Copy code my_python_project/ No Spaces: Avoid spaces in directory names. If needed, use underscores (_) to separate words. For example:

text Copy code my_python_project/ Descriptive Names: Directories should be named to clearly represent the contents or purpose of the code inside. This improves the overall readability and organization of the project. For example, a directory for test files could be named tests/ or test_utils/.

Special Directory Names: There are special directory names in Python projects, such as init.py to mark a directory as a Python package, and tests/ for testing files. These should be used according to the project needs but follow the same lowercase naming convention.

Example Directory Structure: text Copy code my_python_project/ │ ├── src/ # Source code directory │ ├── module_a/ # Module A directory │ └── module_b/ # Module B directory │ ├── tests/ # Test files directory │ ├── test_module_a.py │ └── test_module_b.py │ └── README.md # Project documentation Summary: Use lowercase letters and underscores for directory names. Avoid spaces and hyphens. Choose descriptive names that reflect the directory's purpose. By following these guidelines, your Python project will adhere to PEP 8 and maintain good project organization.