diff options
author | Ross Brattain <ross.b.brattain@intel.com> | 2017-06-21 21:51:49 -0700 |
---|---|---|
committer | Ross Brattain <ross.b.brattain@intel.com> | 2017-07-01 01:58:42 -0700 |
commit | c1f9e57c68e7d77967bf94400afb228d72819eb7 (patch) | |
tree | 9ec786c2a88db367bd1b490e7afdfa42ff47ee44 /anteater/src/project_scan.py | |
parent | eceefe7114bc5d0fc94ac77ee4e510c94c1a76bf (diff) |
switch logging to proper usage
The logging methods do string interpolation themselves
The first arg to logging.debug() is formally defined to be a message
format string.
From the reference:
https://docs.python.org/2/library/logging.html#logging.Logger.debug
Logger.debug(msg, *args, **kwargs)
Logs a message with level DEBUG on this logger. The msg is the message
format string, and the args are the arguments which are merged into msg
using the string formatting operator. (Note that this means that you can
use keywords in the format string, together with a single dictionary
argument.)
There are two keyword arguments in kwargs which are inspected: exc_info
which, if it does not evaluate as false, causes exception information to
be added to the logging message. If an exception tuple (in the format
returned by sys.exc_info()) is provided, it is used; otherwise,
sys.exc_info() is called to get the exception information
The reason logging does string interpolation it self is to implement
deferred interpolation.
String interpolation involves evaluating arguments, so it can introduce
significant computation. The logging module tries to be smart about
deferring interpolation until the last possible moment.
The logging methods check isEnabledFor for the log level and won't
interpolate if the level is not enabled.
https://github.com/python/cpython/blob/2.7/Lib/logging/__init__.py#L1178
def warning(self, msg, *args, **kwargs):
if self.isEnabledFor(WARNING):
self._log(WARNING, msg, args, **kwargs)
logging actually waits to interpolate the string in LogRecord.getMessage()
https://github.com/python/cpython/blob/2.7/Lib/logging/__init__.py#L328
if self.args:
msg = msg % self.args
Change-Id: I0090dcbc408200b6f2471748eae0c5a763da2e37
Signed-off-by: Ross Brattain <ross.b.brattain@intel.com>
Diffstat (limited to 'anteater/src/project_scan.py')
-rw-r--r-- | anteater/src/project_scan.py | 42 |
1 files changed, 16 insertions, 26 deletions
diff --git a/anteater/src/project_scan.py b/anteater/src/project_scan.py index 647c256..0b5c80b 100644 --- a/anteater/src/project_scan.py +++ b/anteater/src/project_scan.py @@ -76,10 +76,8 @@ def scan_file(project_dir, project, binary_list, file_audit_list, if file_audit_list.search(full_path) and not \ file_audit_project_list.search(full_path): match = file_audit_list.search(full_path) - logger.error('Blacklisted filename: {0}'. - format(full_path)) - logger.error('Matched String: {0}'. - format(match.group())) + logger.error('Blacklisted filename: %s', full_path) + logger.error('Matched String: %s', match.group()) with open(reports_dir + "file-names_" + project + ".log", "a") as gate_report: gate_report. \ @@ -97,12 +95,9 @@ def scan_file(project_dir, project, binary_list, file_audit_list, if file_content_list.search(line) and not \ project_content_list.search(line): match = file_content_list.search(line) - logger.error('File contains violation: {0}'. - format(full_path)) - logger.error('Flagged Content: {0}'. - format(line.rstrip())) - logger.error('Matched String: {0}'. - format(match.group())) + logger.error('File contains violation: %s', full_path) + logger.error('Flagged Content: %s', line.rstrip()) + logger.error('Matched String: %s', match.group()) with open(reports_dir + "contents-" + project + ".log", "a") \ as gate_report: @@ -124,13 +119,13 @@ def scan_file(project_dir, project, binary_list, file_audit_list, buf = afile.read() hasher.update(buf) if hasher.hexdigest() in binary_hash: - logger.info('Found matching file hash for file: {0}'. - format(full_path)) + logger.info('Found matching file hash for file: %s', + full_path) else: - logger.error('Non Whitelisted Binary file: {0}'. - format(full_path)) - logger.error('Please submit patch with this hash: {0}'. - format(hasher.hexdigest())) + logger.error('Non Whitelisted Binary file: %s', + full_path) + logger.error('Please submit patch with this hash: %s', + hasher.hexdigest()) with open(reports_dir + "binaries-" + project + ".log", "a") \ as gate_report: @@ -140,11 +135,9 @@ def scan_file(project_dir, project, binary_list, file_audit_list, def licence_root_check(project_dir, project): if os.path.isfile(project_dir + '/LICENSE'): - logger.info('LICENSE file present in: {0}'. - format(project_dir)) + logger.info('LICENSE file present in: %s', project_dir) else: - logger.error('LICENSE file missing in: {0}'. - format(project_dir)) + logger.error('LICENSE file missing in: %s', project_dir) with open(reports_dir + "licence-" + project + ".log", "a") \ as gate_report: @@ -167,14 +160,11 @@ def licence_check(licence_ext, licence_ignore, project, project_dir): # of a decision made at 2017 plugfest to limit searches to # just these two strings. if re.search("copyright", content, re.IGNORECASE): - logger.info('Licence string present: {0}'. - format(full_path)) + logger.info('Licence string present: %s', full_path) elif re.search("spdx", content, re.IGNORECASE): - logger.info('Licence string present: {0}'. - format(full_path)) + logger.info('Licence string present: %s', full_path) else: - logger.error('Licence header missing: {0}'. - format(full_path)) + logger.error('Licence header missing: %s', full_path) with open(reports_dir + "licence-" + project + ".log", "a") \ as gate_report: |