Welcome to Flake8-AAA’s documentation

Flake8-AAA

A linter for Python tests.

• Pytest and unittest styles supported.
• Tests are linted against the Arrange Act Assert pattern.
• Provides a Flake8 interface to automatically lint test files as part of your Flake8 run.
• Provides a command line interface for custom (non-Flake8) usage and debugging.

Installation

Install with pip:

$ pip install flake8-aaa

Integration with Flake8

Given that you already have Flake8 installed in the same environment, check that Flake8-AAA was installed correctly by asking flake8 for its version signature:

$ flake8 --version
3.6.0 (aaa: 0.4.0, mccabe: 0.6.1, pycodestyle: 2.4.0, pyflakes: 2.0.0) CPython 3.6.7 on Linux

The (aaa: 0.4.0, ... part of that output tells you flake8 found this plugin. Now you can run flake8 as usual against your project and Flake8-AAA will lint your tests via its plugin:

$ flake8

Resources

• Documentation on ReadTheDocs
• Package on PyPI
• Source code on GitHub
• Licensed on MIT
• Changelog

Tested on Pythons 3.5 and 3.6.

Python 2 supported up to v0.4.0: pypi, docs, tag.

Contents

• Test discovery
• Rules and 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
  • AAA99: collision when marking this line as NEW_CODE, was already OLD_CODE
• Controlling Flake8-AAA
  • In code
  • Command line
• Release checklist
  • Pre-release steps
  • Post release checks