<aside> 📌 This style guide is publicly accessible, linked to from the engineering site.

</aside>

Introduction

This document defines the Python coding conventions for Thread. Many of these conventions are checked with tools. Where they are, the error code is given in brackets: [F123].

Rationale

In a team environment, code that is difficult to read causes problems:

• Misconceptions can lead to bugs
• It can slow developers down as it takes a while to interpret
• They may have to interrupt other people to ask what is going on

Good style often increases the level of code review that is possible.

When to violate this guide

Sometimes this guide does not apply. When in doubt, use your best judgment. Look at other examples and decide what looks best. Two good reasons to break a particular rule:

• When applying the rule would make the code less readable, even for someone who is used to reading code that follows the rules.
• To be consistent with surrounding code that also breaks it – although this is also an opportunity to clean up the surrounding code.

Style

Indentation

• Use 4 spaces per indentation level. [E111]