Skip to content

Commit

Permalink
Optimize logger lines with formatting (ansible#385)
Browse files Browse the repository at this point in the history
  • Loading branch information
Shrews committed Jun 3, 2022
1 parent b80c310 commit f92a3c9
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions ansible_builder/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ def run():
elif args.action == 'introspect':
data = process(args.folder, user_pip=args.user_pip, user_bindep=args.user_bindep)
if args.sanitize:
logger.info('# Sanitized dependencies for {0}'.format(args.folder))
logger.info('# Sanitized dependencies for %s', args.folder)
data_for_write = data
data['python'] = sanitize_requirements(data['python'])
data['system'] = simple_combine(data['system'])
else:
logger.info('# Dependency data for {0}'.format(args.folder))
logger.info('# Dependency data for %s', args.folder)
data_for_write = data.copy()
data_for_write['python'] = simple_combine(data['python'])
data_for_write['system'] = simple_combine(data['system'])
Expand Down
2 changes: 1 addition & 1 deletion ansible_builder/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ def build_command(self):
return command

def build(self):
logger.debug(f'Ansible Builder is building your execution environment image. Tags: {", ".join(self.tags)}')
logger.debug('Ansible Builder is building your execution environment image. Tags: %s', ", ".join(self.tags))
self.write_containerfile()
run_command(self.build_command)
if self.prune_images:
Expand Down
4 changes: 2 additions & 2 deletions ansible_builder/requirements.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ def sanitize_requirements(collection_py_reqs):
consolidated.append(req)
seen_pkgs.add(req.name)
except Exception as e:
logger.warning('Warning: failed to parse requirements from {}, error: {}'.format(collection, e))
logger.warning('Warning: failed to parse requirements from %s, error: %s', collection, e)

# removal of unwanted packages
sanitized = []
for req in consolidated:
# Exclude packages, unless it was present in the user supplied requirements.
if req.name and req.name.lower() in EXCLUDE_REQUIREMENTS and 'user' not in req.collections:
logger.debug(f'# Excluding requirement {req.name} from {req.collections}')
logger.debug('# Excluding requirement %s from %s', req.name, req.collections)
continue
if req.vcs or req.uri:
# Requirement like git+ or http return as-is
Expand Down
22 changes: 11 additions & 11 deletions ansible_builder/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def configure_logger(verbosity):

def run_command(command, capture_output=False, allow_error=False):
logger.info('Running command:')
logger.info(' {0}'.format(' '.join(command)))
logger.info(' %s', ' '.join(command))
try:
process = subprocess.Popen(command,
stdout=subprocess.PIPE,
Expand Down Expand Up @@ -102,7 +102,7 @@ def run_command(command, capture_output=False, allow_error=False):
main_logger = logging.getLogger('ansible_builder')
if main_logger.level > logging.INFO:
logger.error('Command that had error:')
logger.error(' {0}'.format(' '.join(command)))
logger.error(' %s', ' '.join(command))
if main_logger.level > logging.DEBUG:
if capture_output:
for line in output:
Expand All @@ -114,7 +114,7 @@ def run_command(command, capture_output=False, allow_error=False):
for line in trailing_output:
logger.error(line)
logger.error('')
logger.error(f"An error occured (rc={rc}), see output line(s) above for details.")
logger.error("An error occured (rc=%s), see output line(s) above for details.", rc)
sys.exit(1)

return (rc, output)
Expand All @@ -123,16 +123,16 @@ def run_command(command, capture_output=False, allow_error=False):
def write_file(filename: str, lines: list) -> bool:
parent_dir = os.path.dirname(filename)
if parent_dir and not os.path.exists(parent_dir):
logger.warning('Creating parent directory for {0}'.format(filename))
logger.warning('Creating parent directory for %s', filename)
os.makedirs(parent_dir)
new_text = '\n'.join(lines)
if os.path.exists(filename):
with open(filename, 'r') as f:
if f.read() == new_text:
logger.debug("File {0} is already up-to-date.".format(filename))
logger.debug("File %s is already up-to-date.", filename)
return False
else:
logger.warning('File {0} had modifications and will be rewritten'.format(filename))
logger.warning('File %s had modifications and will be rewritten', filename)
with open(filename, 'w') as f:
f.write(new_text)
return True
Expand All @@ -142,21 +142,21 @@ def copy_file(source: str, dest: str) -> bool:
should_copy = False

if os.path.abspath(source) == os.path.abspath(dest):
logger.info("File {0} was placed in build context by user, leaving unmodified.".format(dest))
logger.info("File %s was placed in build context by user, leaving unmodified.", dest)
return False
elif not os.path.exists(dest):
logger.debug("File {0} will be created.".format(dest))
logger.debug("File %s will be created.", dest)
should_copy = True
elif not filecmp.cmp(source, dest, shallow=False):
logger.warning('File {0} had modifications and will be rewritten'.format(dest))
logger.warning('File %s had modifications and will be rewritten', dest)
should_copy = True
elif os.path.getmtime(source) > os.path.getmtime(dest):
logger.warning('File {0} updated time increased and will be rewritten'.format(dest))
logger.warning('File %s updated time increased and will be rewritten', dest)
should_copy = True

if should_copy:
shutil.copy2(source, dest)
else:
logger.debug("File {0} is already up-to-date.".format(dest))
logger.debug("File %s is already up-to-date.", dest)

return should_copy

0 comments on commit f92a3c9

Please sign in to comment.