Flake8-AAA documentation

Overview

Flake8-AAA is a Flake8 plugin that checks Python tests follow the Arrange-Act-Assert pattern.

Please see the README on GitHub for a general introduction to this project and AAA.

Continue here for more detail about using Flake8-AAA.

Contents

• Compatibility list
  • Python
  • Flake8
  • Yapf
  • Black
  • Pytest
  • Unittest
  • Previous Python versions
• Error codes
  • AAA01: no Act block found in test
  • AAA02: multiple Act blocks found in test
  • AAA03: expected 1 blank line before Act block, found none
  • AAA04: expected 1 blank line before Assert block, found none
  • AAA05: blank line in block
  • AAA06: comment in Act block
  • AAA99: collision when marking this line as NEW_CODE, was already OLD_CODE
• Options and configuration
  • Act block style
• Directives
  • Explicitly marking blocks
  • Disabling Flake8-AAA selectively
• Test discovery and analysis
  • File filtering
  • Processing
• Command line
  • Invocation, output and return value
  • Directives and command line
  • Line markers
• Release checklist
  • Versioning
  • Merge
  • Test PyPI
  • Tag and push
  • Post release checks