Learning Python – Coding Style

  • 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

Enjoy what you’re reading? Subscribe to my newsletter and get more content on AWS and serverless technologies delivered straight to your inbox.


Yan Cui

I’m an AWS Serverless Hero and the author of Production-Ready Serverless. I have run production workload at scale in AWS for nearly 10 years and I have been an architect or principal engineer with a variety of industries ranging from banking, e-commerce, sports streaming to mobile gaming. I currently work as an independent consultant focused on AWS and serverless.

You can contact me via Email, Twitter and LinkedIn.

Hire me.


Check out my new course, Complete Guide to AWS Step Functions.

In this course, we’ll cover everything you need to know to use AWS Step Functions service effectively. Including basic concepts, HTTP and event triggers, activities, design patterns and best practices.

Get Your Copy