def dev_version():
"""
Returns a hexdigest of all the python files in the module.
"""
md5_hash = hashlib.md5()
py_files = sorted(list_files(suffix=".py"))
if not py_files:
return ''
for filename in py_files:
with open(filename, 'rb') as fobj:
content = fobj.read()
md5_hash.update(content)
return md5_hash.hexdigest()
def test_format_pep8():
"""
Test if pep8 is respected.
"""
pep8_checker = StyleGuide()
files_to_check = []
for path in list_files(".py"):
rel_path = os.path.relpath(path, cleverhans.__path__[0])
if rel_path in whitelist_pep8:
continue
else:
files_to_check.append(path)
report = pep8_checker.check_files(files_to_check)
if report.total_errors > 0:
raise AssertionError("PEP8 Format not respected")
def verify_format_docstrings():
"""
Implementation of `test_format_docstrings`. The implementation is
factored out so it can be placed inside a guard against SkipTest.
"""
format_infractions = []
for path in list_files(".py"):
rel_path = os.path.relpath(path, cleverhans.__path__[0])
if rel_path in whitelist_docstrings:
continue
try:
format_infractions.extend(docstring_errors(path))
except Exception as e:
format_infractions.append(["%s failed to run so format cannot "
"be checked. Error message:\n %s" %
(rel_path, e)])
if len(format_infractions) > 0:
msg = "\n".join(':'.join(line) for line in format_infractions)
raise AssertionError("Docstring format not respected:\n%s" % msg)
def print_files_information_pep8():
"""
Print the list of files which can be removed from the whitelist and the
list of files which do not respect PEP8 formatting that aren't in the
whitelist
"""
infracting_files = []
non_infracting_files = []
pep8_checker = StyleGuide(quiet=True)
for path in list_files(".py"):
number_of_infractions = pep8_checker.input_file(path)
rel_path = os.path.relpath(path, cleverhans.__path__[0])
if number_of_infractions > 0:
if rel_path not in whitelist_pep8:
infracting_files.append(path)
else:
if rel_path in whitelist_pep8:
non_infracting_files.append(path)
print("Files that must be corrected or added to whitelist:")
for file in infracting_files:
print(file)
print("Files that can be removed from whitelist:")
for file in non_infracting_files:
print(file)
def print_files_information_pep8():
"""
Print the list of files which can be removed from the whitelist and the
list of files which do not respect PEP8 formatting that aren't in the
whitelist
"""
infracting_files = []
non_infracting_files = []
pep8_checker = StyleGuide(quiet=True)
for path in list_files(".py"):
number_of_infractions = pep8_checker.input_file(path)
rel_path = os.path.relpath(path, cleverhans.__path__[0])
if number_of_infractions > 0:
if rel_path not in whitelist_pep8:
infracting_files.append(path)
else:
if rel_path in whitelist_pep8:
non_infracting_files.append(path)
print("Files that must be corrected or added to whitelist:")
for file in infracting_files:
print(file)
print("Files that can be removed from whitelist:")
for file in non_infracting_files:
print(file)
from __future__ import print_function
import os
import subprocess
import cleverhans
from cleverhans.devtools.list_files import list_files
from cleverhans.utils import shell_call
# Enter a manual list of files that are allowed to violate PEP8 here
whitelist_pep8 = [
# This file is broken but could be fixed
"../examples/multigpu_advtrain/test_attack_multigpu.py"
]
all_py_files = list_files('.py')
def update_whitelist():
global whitelist_pep8
# We don't want to test RL-attack because it has so many dependencies
# not used elsewhere, and pylint wants to import them all
whitelist_pep8.extend([
os.path.relpath(path, cleverhans.__path__[0]) for path in all_py_files
if "RL-attack" in path
])
# Similarly, we don't want to require robust_vision_benchmark installed
whitelist_pep8.extend([
os.path.relpath(path, cleverhans.__path__[0]) for path in all_py_files
if "robust_vision_benchmark" in path
])
import cleverhans
from cleverhans.devtools.tests.docscrape import docstring_errors
from cleverhans.devtools.list_files import list_files
from cleverhans.utils import shell_call
# Enter a manual list of files that are allowed to violate PEP8 here
whitelist_pep8 = [
# This file is broken but could be fixed
"../examples/multigpu_advtrain/test_attack_multigpu.py"
]
# We don't want to test RL-attack because it has so many dependencies
# not used elsewhere, and pylint wants to import them all
whitelist_pep8.extend([
os.path.relpath(path, cleverhans.__path__[0]) for path in list_files(".py")
if "RL-attack" in path
])
# Similarly, we don't want to require robust_vision_benchmark installed
whitelist_pep8.extend([
os.path.relpath(path, cleverhans.__path__[0]) for path in list_files(".py")
if "robust_vision_benchmark" in path
])
# Similarly, we don't want to require that cloud be installed
whitelist_pep8.extend([
os.path.relpath(path, cleverhans.__path__[0]) for path in list_files(".py")
if "cloud_client" in path
])
# This example has more dependencies too
whitelist_pep8.extend([
os.path.relpath(path, cleverhans.__path__[0]) for path in list_files(".py")
"""
Run this script to run autopep8 on everything in the library
"""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from cleverhans.devtools.list_files import list_files
from cleverhans.utils import shell_call
for f in list_files(".py"):
command = ["autopep8", "-i", "--indent-size", "2", f]
shell_call(command)
import os
import cleverhans
from cleverhans.devtools.tests.docscrape import docstring_errors
from cleverhans.devtools.list_files import list_files
from pycodestyle import StyleGuide
# Enter a manual list of files that are allowed to violate PEP8 here
whitelist_pep8 = [
]
# The NIPS 2017 competition code is allowed to violate PEP8 because it
# follows the Google style guide instead (e.g., 2 spaces instead of 4)
whitelist_pep8.extend([os.path.relpath(path, cleverhans.__path__[0])
for path in list_files()
if "nips17_adversarial_competition" in path])
whitelist_docstrings = [
]
def test_format_pep8():
"""
Test if pep8 is respected.
"""
pep8_checker = StyleGuide()
files_to_check = []
for path in list_files(".py"):
rel_path = os.path.relpath(path, cleverhans.__path__[0])
import os
import subprocess
import cleverhans
from cleverhans.devtools.list_files import list_files
from cleverhans.utils import shell_call
# Enter a manual list of files that are allowed to violate PEP8 here
whitelist_pep8 = [
# This file is broken but could be fixed
"../examples/multigpu_advtrain/test_attack_multigpu.py"
]
all_py_files = list_files(".py")
def update_whitelist():
"""Add files to the whitelist"""
global whitelist_pep8
# We don't want to test RL-attack because it has so many dependencies
# not used elsewhere, and pylint wants to import them all
whitelist_pep8.extend(
[
os.path.relpath(path, cleverhans.__path__[0])
for path in all_py_files
if "RL-attack" in path
]
)
# Similarly, we don't want to require robust_vision_benchmark installed