diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000000000000000000000000000000000000..ad5ba6ea8fc5a9e6097c1d118c3bda3fcf6495dc --- /dev/null +++ b/.pylintrc @@ -0,0 +1,222 @@ +# File taken from Tensor2Tensor project +# https://github.com/tensorflow/tensor2tensor/blob/master/pylintrc + +[MASTER] + +# Pickle collected data for later comparisons. +persistent=no + +# Set the cache size for astng objects. +cache-size=500 + +# Ignore Py3 files +ignore=get_references_web.py,get_references_web_single_group.py + + +[REPORTS] + +# Set the output format. +# output-format=sorted-text + +# Put messages in a separate file for each module / package specified on the +# command line instead of printing them on stdout. Reports (if any) will be +# written in a file name "pylint_global.[txt|html]". +files-output=no + +# Tells whether to display a full report or only the messages. +reports=no + +# Disable the report(s) with the given id(s). +disable-report=R0001,R0002,R0003,R0004,R0101,R0102,R0201,R0202,R0220,R0401,R0402,R0701,R0801,R0901,R0902,R0903,R0904,R0911,R0912,R0913,R0914,R0915,R0921,R0922,R0923 + +# Error message template (continued on second line) +msg-template={msg_id}:{line:3} {obj}: {msg} [{symbol}] + + +[MESSAGES CONTROL] +# List of checkers and warnings to enable. +enable=indexing-exception,old-raise-syntax + +# List of checkers and warnings to disable. +disable=design,similarities,no-self-use,attribute-defined-outside-init,locally-disabled,star-args,pointless-except,bad-option-value,global-statement,fixme,suppressed-message,useless-suppression,locally-enabled,file-ignored,multiple-imports,c-extension-no-member,trailing-newlines,unsubscriptable-object,misplaced-comparison-constant,no-member,abstract-method,no-else-return,missing-docstring,wrong-import-order,protected-access,inconsistent-return-statements,invalid-unary-operand-type,import-error,no-name-in-module,arguments-differ,not-context-manager,unused-argument + +[BASIC] + +# Required attributes for module, separated by a comma +required-attributes= + +# Regular expression which should only match the name +# of functions or classes which do not require a docstring. +no-docstring-rgx=(__.*__|main) + +# Min length in lines of a function that requires a docstring. +docstring-min-length=10 + +# Regular expression which should only match correct module names. The +# leading underscore is sanctioned for private modules by Google's style +# guide. +# +# There are exceptions to the basic rule (_?[a-z][a-z0-9_]*) to cover +# requirements of Python's module system. +module-rgx=^(_?[a-z][a-z0-9_]*)|__init__$ + +# Regular expression which should only match correct module level names +const-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ + +# Regular expression which should only match correct class attribute +class-attribute-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ + +# Regular expression which should only match correct class names +class-rgx=^_?[A-Z][a-zA-Z0-9]*$ + +# Regular expression which should only match correct function names. +# 'camel_case' and 'snake_case' group names are used for consistency of naming +# styles across functions and methods. +function-rgx=^(?:(?P<exempt>setUp|tearDown|setUpModule|tearDownModule)|(?P<camel_case>_?[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_?[a-z][a-z0-9_]*))$ + + +# Regular expression which should only match correct method names. +# 'camel_case' and 'snake_case' group names are used for consistency of naming +# styles across functions and methods. 'exempt' indicates a name which is +# consistent with all naming styles. +method-rgx=(?x) + ^(?:(?P<exempt>_[a-z0-9_]+__|runTest|setUp|tearDown|setUpTestCase + |tearDownTestCase|setupSelf|tearDownClass|setUpClass + |(test|assert)_*[A-Z0-9][a-zA-Z0-9_]*|next) + |(?P<camel_case>_{0,2}[A-Z][a-zA-Z0-9_]*) + |(?P<snake_case>_{0,2}[a-z][a-z0-9_]*))$ + + +# Regular expression which should only match correct instance attribute names +attr-rgx=^_{0,2}[a-z][a-z0-9_]*$ + +# Regular expression which should only match correct argument names +argument-rgx=^[a-z][a-z0-9_]*$ + +# Regular expression which should only match correct variable names +variable-rgx=^[a-z][a-z0-9_]*$ + +# Regular expression which should only match correct list comprehension / +# generator expression variable names +inlinevar-rgx=^[a-z][a-z0-9_]*$ + +# Good variable names which should always be accepted, separated by a comma +good-names=main,_ + +# Bad variable names which should always be refused, separated by a comma +bad-names= + +# List of builtins function names that should not be used, separated by a comma +bad-functions=input,apply,reduce + +# List of decorators that define properties, such as abc.abstractproperty. +property-classes=abc.abstractproperty + + +[TYPECHECK] + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# List of decorators that create context managers from functions, such as +# contextlib.contextmanager. +contextmanager-decorators=contextlib.contextmanager,contextlib2.contextmanager + + +[VARIABLES] + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# A regular expression matching names used for dummy variables (i.e. not used). +dummy-variables-rgx=^\*{0,2}(_$|unused_|dummy_) + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# "class_" is also a valid for the first argument to a class method. +valid-classmethod-first-arg=cls,class_ + + +[EXCEPTIONS] + +overgeneral-exceptions=StandardError,Exception,BaseException + + +[IMPORTS] + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=regsub,TERMIOS,Bastion,rexec,sets + + +[FORMAT] + +# Maximum number of characters on a single line. +max-line-length=80 + +# Regexp for a line that is allowed to be longer than the limit. +# This "ignore" regex is today composed of several independent parts: +# (1) Long import lines +# (2) URLs in comments or pydocs. Detecting URLs by regex is a hard problem and +# no amount of tweaking will make a perfect regex AFAICT. This one is a good +# compromise. +# (3) Constant string literals at the start of files don't need to be broken +# across lines. Allowing long paths and urls to be on a single +# line. Also requires that the string not be a triplequoted string. +ignore-long-lines=(?x) + (^\s*(import|from)\s + |^\s*(\#\ )?<?(https?|ftp):\/\/[^\s\/$.?#].[^\s]*>?$ + |^[a-zA-Z_][a-zA-Z0-9_]*\s*=\s*("[^"]\S+"|'[^']\S+') + ) + +# Maximum number of lines in a module +max-module-lines=99999 + +# String used as indentation unit. We differ from PEP8's normal 4 spaces. +indent-string=' ' + +# Do not warn about multiple statements on a single line for constructs like +# if test: stmt +single-line-if-stmt=y + +# Make sure : in dicts and trailing commas are checked for whitespace. +no-space-check= + + +[LOGGING] + +# Add logging modules. +logging-modules=logging,absl.logging + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes= + + +# Maximum line length for lambdas +short-func-length=1 + +# List of module members that should be marked as deprecated. +# All of the string functions are listed in 4.1.4 Deprecated string functions +# in the Python 2.4 docs. +deprecated-members=string.atof,string.atoi,string.atol,string.capitalize,string.expandtabs,string.find,string.rfind,string.index,string.rindex,string.count,string.lower,string.split,string.rsplit,string.splitfields,string.join,string.joinfields,string.lstrip,string.rstrip,string.strip,string.swapcase,string.translate,string.upper,string.ljust,string.rjust,string.center,string.zfill,string.replace,sys.exitfunc,sys.maxint + + +# List of exceptions that do not need to be mentioned in the Raises section of +# a docstring. +ignore-exceptions=AssertionError,NotImplementedError,StopIteration,TypeError + + +# Number of spaces of indent required when the last token on the preceding line +# is an open (, [, or {. +indent-after-paren=4 diff --git a/.vscode/settings.json b/.vscode/settings.json index de8384f9556a6ce610d8fcbbf8c11444fd4c64f7..062785fa846c1f6c1557152b0bfa8a7097705b6e 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -14,7 +14,10 @@ "python.formatting.yapfArgs": [ "--style=chromium" ], + "python.linting.enabled": true, + "python.linting.lintOnSave": true, + "python.linting.pylintEnabled": true, "[python]": { "editor.tabSize": 2 }, -} +} \ No newline at end of file diff --git a/deploy.py b/deploy.py index 192b1dc427eb4ca6f5afebbf5397a1b660228910..1dc3fc8410ec1289e5b253342f3e3af638420668 100755 --- a/deploy.py +++ b/deploy.py @@ -19,12 +19,13 @@ from __future__ import division from __future__ import print_function import argparse -import colorama import copy import os import shutil import subprocess import sys + +import colorama from tockloader.exceptions import TockLoaderException from tockloader import tab, tbfh, tockloader @@ -77,6 +78,7 @@ def info(msg): class RemoveConstAction(argparse.Action): + #pylint: disable=W0622 def __init__(self, option_strings, dest, @@ -100,7 +102,7 @@ class RemoveConstAction(argparse.Action): # https://github.com/python/cpython/blob/master/Lib/argparse.py#L138-L147 # https://github.com/python/cpython/blob/master/Lib/argparse.py#L1028-L1052 items = getattr(namespace, self.dest, []) - if type(items) is list: + if isinstance(items, list): items = items[:] else: items = copy.copy(items) @@ -109,7 +111,7 @@ class RemoveConstAction(argparse.Action): setattr(namespace, self.dest, items) -class OpenSKInstaller(object): +class OpenSKInstaller: def __init__(self, args): colorama.init() @@ -170,7 +172,7 @@ class OpenSKInstaller(object): ["make", "-C", SUPPORTED_BOARDS[self.args.board], "flash"]) def build_and_install_example(self): - assert (self.args.application) + assert self.args.application self.checked_command_output([ "cargo", "build", "--release", "--target=thumbv7em-none-eabi", "--features={}".format(",".join(self.args.features)), "--example", @@ -181,7 +183,7 @@ class OpenSKInstaller(object): self.args.application)) def build_and_install_opensk(self): - assert (self.args.application) + assert self.args.application info("Building OpenSK application") self.checked_command_output([ "cargo", @@ -204,7 +206,7 @@ class OpenSKInstaller(object): "key and/or certificate for OpenSK")) def install_elf_file(self, elf_path): - assert (self.args.application) + assert self.args.application package_parameter = "-n" elf2tab_ver = self.checked_command_output(["elf2tab", "--version"]).split( ' ', maxsplit=1)[1] @@ -306,6 +308,7 @@ class OpenSKInstaller(object): error(("It seems that something went wrong. " "App/example not found on your board.")) return 1 + return 0 def main(args): @@ -330,8 +333,8 @@ if __name__ == '__main__': "applications won't be erased from the board."), ) - parser = argparse.ArgumentParser() - commands = parser.add_subparsers( + main_parser = argparse.ArgumentParser() + commands = main_parser.add_subparsers( dest="action", help=("Indicates which part of the firmware should be compiled and " "flashed to the connected board.")) @@ -390,14 +393,14 @@ if __name__ == '__main__': "(i.e. more debug messages will be sent over the console port " "such as hexdumps of packets)."), ) - apps = app_commands.add_mutually_exclusive_group() - apps.add_argument( + apps_group = app_commands.add_mutually_exclusive_group() + apps_group.add_argument( "--opensk", dest="application", action="store_const", const="ctap2", help="Compiles and installs the OpenSK application.") - apps.add_argument( + apps_group.add_argument( "--crypto_bench", dest="application", action="store_const", @@ -407,4 +410,4 @@ if __name__ == '__main__': app_commands.set_defaults(features=["with_ctap1"]) - main(parser.parse_args()) + main(main_parser.parse_args())