STYLE_GUIDE.md

OpenThread Coding Conventions and Style

• 1 Python
  • 1.1 Standards
  • 1.2 Conventions and Best Practices
  • 1.3 Format and Style

Python

Standards

• OpenThread uses and enfores both Python 2 and Python 3. Support for Python 2 is a result of the fact that some current Linux distributions and Macs are still using 2.x as default.

Conventions and Best Practices

• Run pylint over your code. pylint is a tool for finding bugs and style problems in Python source code. It finds problems that are typically caught by a compiler for less dynamic languages like C and C++. Because of the dynamic nature of Python, some warnings may be incorrect; however, spurious warnings should be fairly infrequent.

Format and Style

• All code should adhere to PEP 8.