Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Coding Style Guide

Autopush uses Rust styling guides based on cargo fmt and cargo clippy

Testing Style Guide

Given the integration and load tests are written in Python, we follow a few simple style conventions:

  • We conform to the PEP 8 standard Style Guide.
  • We use type annotations for all variables, functions, and classes.
  • We check linting automatically running make lint from the root directory. Each subsequent check can be run manually. Consult the Makefile for commands.
  • We use flake8 as our core style enforcement linter.
  • We use black for formatting and isort for import formatting.
  • We use mypy for type annotation checking.
  • We use pydocstyle for docstring conventions.
  • We use bandit for static code security analysis.

Exceptions