mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
99d4f5bab4
* Remove uses of assert in production code * Fix assertion * Add code smell test for assertions, currently limited to lib/ansible * Fix assertion * Add docs for no-assert * Remove new assert from enos * Fix assert in module_utils.connection
40 lines
1.2 KiB
Python
Executable file
40 lines
1.2 KiB
Python
Executable file
#!/usr/bin/env python
|
|
from __future__ import print_function
|
|
|
|
import os
|
|
import re
|
|
import sys
|
|
|
|
from collections import defaultdict
|
|
|
|
PATH = 'lib/ansible'
|
|
ASSERT_RE = re.compile(r'.*(?<![-:a-zA-Z#][ -])\bassert\b(?!:).*')
|
|
|
|
all_matches = defaultdict(list)
|
|
|
|
for dirpath, dirnames, filenames in os.walk(PATH):
|
|
for filename in filenames:
|
|
path = os.path.join(dirpath, filename)
|
|
if not os.path.isfile(path) or not path.endswith('.py'):
|
|
continue
|
|
|
|
with open(path, 'r') as f:
|
|
for i, line in enumerate(f.readlines()):
|
|
matches = ASSERT_RE.findall(line)
|
|
|
|
if matches:
|
|
all_matches[path].append((i + 1, line.index('assert') + 1, matches))
|
|
|
|
|
|
if all_matches:
|
|
print('Use of assert in production code is not recommended.')
|
|
print('Python will remove all assert statements if run with optimizations')
|
|
print('Alternatives:')
|
|
print(' if not isinstance(value, dict):')
|
|
print(' raise AssertionError("Expected a dict for value")')
|
|
|
|
for path, matches in all_matches.items():
|
|
for line_matches in matches:
|
|
for match in line_matches[2]:
|
|
print('%s:%d:%d: %s' % ((path,) + line_matches[:2] + (match,)))
|
|
sys.exit(1)
|