Learning Python — Coding Style

Yan Cui
theburningmonk.com
Published in
1 min readMar 19, 2011
  • Use 4-space indentation, no tabs
  • Wrap lines so that they don’t exceed 79 characters
  • Use blank lines to separate functions and classes, and larger blocks of code inside functions
  • When possible, put comments on a line of their own
  • Use docstrings
  • Use spaces around operators and after commas
  • Name your classes and functions consistently; the convention is to use CamelCase for classes and lower_case_with_underscores for functions and methods
  • Always use self as the name for the first method argument
  • Don’t use fancy encodings if your code is meant to be used in international environments
  • Naming conventions:
  • Variables / functions — use_lower_case_separated_by_underscore
  • Class names — UseCamelCase
  • Error classes end in Error, i.e. MyError

--

--

Yan Cui
theburningmonk.com

AWS Serverless Hero. Follow me to learn practical tips and best practices for AWS and Serverless.