Skip to main content

Flake8 Unittest Assertion Checker

PyPI Version Python Versions

flake8-assertive is a Flake8 extension that encourages using richer, more specific unittest assertions beyond just the typical assertEqual(a, b) and assertTrue(x) methods. The suggested methods perform more precise checks and provide better failure messages than the generic methods.

Original

Suggestion

Code

assertTrue(a == b)

assertEqual(a, b)

A500

assertTrue(a != b)

assertNotEqual(a, b)

A500

assertFalse(a == b)

assertNotEqual(a, b)

A500

assertFalse(a != b)

assertEqual(a, b)

A500

assertTrue(a < b)

assertLess(a, b)

A500

assertTrue(a <= b)

assertLessEqual(a, b)

A500

assertTrue(a > b)

assertGreater(a, b)

A500

assertTrue(a >= b)

assertGreaterEqual(a, b)

A500

assertTrue(a is b)

assertIs(a, b)

A501

assertTrue(a is not b)

assertIsNot(a, b)

A501

assertFalse(a is b)

assertNotIs(a, b)

A501

assertFalse(a is not b)

assertIs(a, b)

A501

assertTrue(a in b)

assertIn(a, b)

A501

assertFalse(a in b)

assertNotIn(a, b)

A501

assertTrue(isinstance(a, b))

assertIsInstance(a, b)

A501

assertFalse(isinstance(a, b))

assertNotIsInstance(a, b)

A501

assertEqual(a, round(b, x))

assertAlmostEqual(a, b, x)

A501

assertAlmostEqual(a, round(b, x))

assertAlmostEqual(a, b, x)

A501

assertNotEqual(a, round(b, x))

assertNotAlmostEqual(a, b, x)

A501

assertNotAlmostEqual(a, round(b, x))

assertNotAlmostEqual(a, b, x)

A501

assertEqual(a, None)

assertIsNone(a)

A502

assertNotEqual(a, None)

assertIsNotNone(a)

A502

assertTrue(a is None)

assertIsNone(a)

A502

assertTrue(a is not None)

assertIsNotNone(a)

A502

assertFalse(a is None)

assertIsNotNone(a)

A502

assertFalse(a is not None)

assertIsNone(a)

A502

assertEqual(a, True)

assertTrue(a)

A502

assertEqual(a, False)

assertFalse(a)

A502

assertEquals(a, b)

assertEqual(a, b)

A503

assertNotEquals(a, b)

assertNotEqual(a, b)

A503

assertAlmostEquals(a, b, x)

assertAlmostEqual(a, b, x)

A503

assertNotAlmostEquals(a, b, x)

assertNotAlmostEqual(a, b, x)

A503

Note that some suggestions are normalized forms of the original, such as when a double-negative is used (assertFalse(a != b) → assertEqual(a, b)). There aren’t suggestions for things like assertFalse(a > b), which may or may not be equivalent to assertLessEqual(a, b).

Installation

Install from PyPI using pip:

$ pip install flake8-assertive

The extension will be activated automatically by flake8. You can verify that it has been loaded by inspecting the flake8 --version string.

$ flake8 --version
3.7.9 (assertive: 1.2.0, ...) CPython 2.7.17 on Darwin

Error Codes

This extension adds three new error codes (using the A50 prefix):

  • A500: prefer {func} for ‘{op}’ comparisons

  • A501: prefer {func} for ‘{op}’ expressions

  • A502: prefer {func} instead of comparing to {obj}

  • A503: use {func} instead of the deprecated {name}

Configuration

Configuration values are specified in the [flake8] section of your config file or as command line arguments (e.g. --assertive-snakecase).

  • assertive-snakecase: suggest snake_case assert method names (e.g. assert_true()) instead of the standard names (e.g. assertTrue())

  • assertive-test-pattern: fnmatch pattern for identifying unittest test files (and all other files will be skipped)

Caveats

There are some specific cases when the suggestion might not match the intent of the original.

Testing the equality operator

assertEqual() won’t use the == operator if the comparison has been delegated to a type-specific equalilty function. By default, this is the case for strings, sequences, lists, tuples, sets, and dicts.

If your intent is to specifically test the == operator, consider writing the assertion like this instead:

assertIs(a == b, True)

This approach has the benefit of verifying that the type’s __eq__ implementation returns a boolean value. Unfortunately, it also has the downside of reporting the result of a == b on failure instead of the values of a and b.

Suggested by: Serhiy Storchaka

Changes

1.2.0 (2019-12-05)

  • Suggest the preferred names for deprecated methods, such as assertEqual() instead of assertEquals().

1.1.0 (2019-06-26)

  • Suggest assertAlmostEqual(a, b, x) for round() expressions like in assertEqual(a, round(b, x)) and assertAlmostEqual(a, round(b, x)) (and similar for assertNotEqual() and assertNotAlmostEqual().

  • Recognize assertAmostEquals() and assertNotAlmostEquals() as aliases for assertAlmostEqual() and assertNotAlmostEqual().

  • Drop Python 3.4 as a supported version since it has been officially retired.

1.0.1 (2018-07-03)

  • Don’t make suggestions for assertions containing multiple comparison operations (e.g. assertTrue(a == b == c)).

1.0.0 (2018-06-04)

  • Suggest assertIsNone(a) for assertTrue(a is None), etc.

  • Recognize assertEquals() and assertNotEquals() as aliases for assertEqual() and assertNotEqual().

0.9.0 (2018-05-14)

  • Initial beta release

Metadata

Release files for flake8-assertive 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for flake8-assertive 1.2.0
File Size Uploaded
flake8-assertive-1.2.0.tar.gz 7.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for flake8-assertive 1.2.0
File Interpreter ABI Platform
flake8_assertive-1.2.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 15.2 kB

Release files / flake8-assertive-1.2.0.tar.gz

Download URL flake8-assertive-1.2.0.tar.gz
Size 7.7 kB
Tags Source
SHA-256 checksum
How to use checksums
b0645b0a745a88490a5d19b365f45998b98b3b5e402afaaa2cb337fd8c37adb9
BLAKE2b-256 checksum
How to use checksums
46cb4925fe4486fca5a3257181571c5f1bfe9bc49d6b8ca2396bba902d839707
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.4.2 requests/2.11.1 setuptools/41.4.0 requests-toolbelt/0.8.0 tqdm/4.15.0 CPython/2.7.17

Release files / flake8_assertive-1.2.0-py2.py3-none-any.whl

Download URL flake8_assertive-1.2.0-py2.py3-none-any.whl
Size 7.5 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
43fa215c5dbc70bfbb4de8ea7b8b44cbdc11268bf36a6cd944f8ff9463ba94a6
BLAKE2b-256 checksum
How to use checksums
69b386e4478dc8b5f6b72e2501393b2a988ef2c6cbefc429af1613bd082faa87
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.4.2 requests/2.11.1 setuptools/41.4.0 requests-toolbelt/0.8.0 tqdm/4.15.0 CPython/2.7.17

Release history Release notifications | RSS feed

2.3.0

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.3.0

2 release files

1.2.1

2 release files

This release

1.2.0 This release

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.9.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page