Tag Archives: #prescriptive

Python conventions (Zen of Python)

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

Coding conventions are rules that were created by programers to make people’s life easier when reading a code. 

These conventions were created in order to have a better style when programming and that way, make the code easier to understand. 

Coding conventions include:

• Introduction
• A Foolish Consistency is the Hobgoblin of Little Minds
• Code lay-out
  • Indentation
  • Tabs or Spaces?
  • Maximum Line Length
  • Blank Lines
  • Source File Encoding
  • Imports
• String Quotes
• Whitespace in Expressions and Statements
  • Pet Peeves
  • Other Recommendations
• Comments
  • Block Comments
  • Inline Comments
  • Documentation Strings
• Version Bookkeeping
• Naming Conventions
  • Overriding Principle
  • Descriptive: Naming Styles
  • Prescriptive: Naming Conventions
    • Names to Avoid
    • Package and Module Names
    • Class Names
    • Exception Names
    • Global Variable Names
    • Function Names
    • Function and method arguments
    • Method Names and Instance Variables
    • Constants
    • Designing for inheritance
  • Public and internal interfaces
• Programming Recommendations
• References
• Copyright