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

Liked this article? Support me on Patreon and get direct help from me via a private Slack channel or 1-2-1 mentoring.
Subscribe to my newsletter


Hi, I’m Yan. I’m an AWS Serverless Hero and the author of Production-Ready Serverless.

I specialise in rapidly transitioning teams to serverless and building production-ready services on AWS.

Are you struggling with serverless or need guidance on best practices? Do you want someone to review your architecture and help you avoid costly mistakes down the line? Whatever the case, I’m here to help.

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, callbacks, nested workflows, design patterns and best practices.

Get Your Copy