学习笔记之PEP 8 -- Style Guide for Python Code

PEP 8 -- Style Guide for Python Code | Python.org

• https://www.python.org/dev/peps/pep-0008/

Contents

• Introduction
• A Foolish Consistency is the Hobgoblin of Little Minds
• Code Lay-out
  • Indentation
  • Tabs or Spaces?
  • Maximum Line Length
  • Should a Line Break Before or After a Binary Operator?
  • Blank Lines
  • Source File Encoding
  • Imports
  • Module Level Dunder Names
• String Quotes
• Whitespace in Expressions and Statements
  • Pet Peeves
  • Other Recommendations
• When to Use Trailing Commas
• Comments
  • Block Comments
  • Inline Comments
  • Documentation Strings
• Naming Conventions
  • Overriding Principle
  • Descriptive: Naming Styles
  • Prescriptive: Naming Conventions
    • Names to Avoid
    • ASCII Compatibility
    • Package and Module Names
    • Class Names
    • Type Variable Names
    • Exception Names
    • Global Variable Names
    • Function and Variable Names
    • Function and Method Arguments
    • Method Names and Instance Variables
    • Constants
    • Designing for Inheritance
  • Public and Internal Interfaces
• Programming Recommendations
  • Function Annotations
  • Variable Annotations
• References
• Copyright

---

Code Lay-out