Changes to use f-strings instead of format (#1265)

Author: joachimmetz

l2tdevtools/review_helpers/cli.py

@@ -59,11 +59,9 @@ def RunCommand(self, command):
         error = codecs.decode(error, self.preferred_encoding)
         exit_code = process.returncode
         if exit_code != 0:
-          logging.error('Running: "{0:s}" failed with error: {1!s}.'.format(
-              command, error))
+          logging.error(f'Running: "{command:s}" failed with error: {error!s}.')
 
     except OSError as exception:
-      logging.error('Running: "{0:s}" failed with error: {1!s}'.format(
-          command, exception))
+      logging.error(f'Running: "{command:s}" failed with error: {exception!s}')
 
     return exit_code, output, error

l2tdevtools/review_helpers/github.py

@@ -40,10 +40,10 @@ def AssignPullRequest(
     post_data = json.dumps({"assignees": assignees})
 
     github_url = (
-        'https://api.github.com/repos/{0:s}/{1:s}/issues/{2:d}/'
-        'assignees?access_token={3:s}').format(
-            self._organization, self._project, pull_request_number,
-            access_token)
+        f'https://api.github.com/repos/'
+        f'{self._organization:s}/{self._project:s}/issues/'
+        f'{pull_request_number:d}/assignees?'
+        f'access_token={access_token:s}')
 
     try:
       self._url_lib_helper.Request(github_url, post_data=post_data)
@@ -78,18 +78,18 @@ def CreatePullRequest(self, access_token, origin, title, body, no_edit=False):
 
     # Note that the maintainer_can_modify is a JSON boolean value.
     post_data = (
-        '{{\n'
-        '  "title": "{0:s}",\n'
-        '  "body": "{1:s}",\n'
-        '  "head": "{2:s}",\n'
-        '  "base": "main",\n'
-        '  "maintainer_can_modify": {3:s}\n'
-        '}}\n').format(title, body, origin, maintainer_can_modify)
+        f'{{\n'
+        f'  "title": "{title:s}",\n'
+        f'  "body": "{body:s}",\n'
+        f'  "head": "{origin:s}",\n'
+        f'  "base": "main",\n'
+        f'  "maintainer_can_modify": {maintainer_can_modify:s}\n'
+        f'}}\n')
 
     github_url = (
-        'https://api.github.com/repos/{0:s}/{1:s}/pulls?'
-        'access_token={2:s}').format(
-            self._organization, self._project, access_token)
+        f'https://api.github.com/repos/'
+        f'{self._organization:s}/{self._project:s}/pulls?'
+        f'access_token={access_token:s}')
 
     response_data = self._url_lib_helper.Request(
         github_url, post_data=post_data)
@@ -118,10 +118,10 @@ def CreatePullRequestReview(
     post_data = json.dumps({"reviewers": reviewers})
 
     github_url = (
-        'https://api.github.com/repos/{0:s}/{1:s}/pulls/{2:d}/'
-        'requested_reviewers?access_token={3:s}').format(
-            self._organization, self._project, pull_request_number,
-            access_token)
+        f'https://api.github.com/repos/'
+        f'{self._organization:s}/{self._project:s}/pulls/'
+        f'{pull_request_number:d}/requested_reviewers?'
+        f'access_token={access_token:s}')
 
     try:
       self._url_lib_helper.Request(github_url, post_data=post_data)
@@ -140,7 +140,7 @@ def GetForkGitRepoUrl(self, username):
     Returns:
       str: git repository URL or None.
     """
-    return 'https://github.com/{0:s}/{1:s}.git'.format(username, self._project)
+    return f'https://github.com/{username:s}/{self._project:s}.git'
 
   def GetUsername(self, access_token):
     """Retrieves a GitHub user.
@@ -151,9 +151,7 @@ def GetUsername(self, access_token):
     Returns:
       str: GitHub user name or None if not available.
     """
-    github_url = (
-        'https://api.github.com/user?access_token={0:s}').format(
-            access_token)
+    github_url = f'https://api.github.com/user?access_token={access_token:s}'
 
     try:
       response_data = self._url_lib_helper.Request(github_url)
@@ -178,13 +176,13 @@ def QueryUser(self, username):
     Returns:
       dict[str,object]: JSON response or None if not available.
     """
-    github_url = 'https://api.github.com/users/{0:s}'.format(username)
+    github_url = f'https://api.github.com/users/{username:s}'
 
     try:
       response_data = self._url_lib_helper.Request(github_url)
 
     except errors.ConnectivityError as exception:
-      logging.warning('{0!s}'.format(exception))
+      logging.warning(f'{exception!s}')
       return None
 
     if isinstance(response_data, bytes):

l2tdevtools/review_helpers/pylint.py

@@ -55,24 +55,24 @@ def CheckFiles(self, filenames, rcfile):
     print('Running linter on changed files.')
     failed_filenames = []
     for filename in filenames:
-      print('Checking: {0:s}'.format(filename))
+      print(f'Checking: {filename:s}')
 
-      command = 'pylint --rcfile="{0:s}" {1:s}'.format(rcfile, filename)
+      command = f'pylint --rcfile="{rcfile:s}" {filename:s}'
       # For now disable pylint 2.1.1 and later specific checks.
       if version_tuple >= (2, 1, 1):
         additional_checks = [
             'assignment-from-none', 'chained-comparison',
             'useless-object-inheritance']
-        command = '{0:s} --disable={1:s}'.format(
-            command, ','.join(additional_checks))
+        disable_checks = ','.join(additional_checks)
+        command = f'{command:s} --disable={disable_checks:s}'
 
       exit_code = subprocess.call(command, shell=True)
       if exit_code != 0:
         failed_filenames.append(filename)
 
     if failed_filenames:
-      print('\nFiles with linter errors:\n{0:s}\n'.format(
-          '\n'.join(failed_filenames)))
+      filenames_string = '\n'.join(failed_filenames)
+      print(f'\nFiles with linter errors:\n{filenames_string:s}\n')
       return False
 
     return True

l2tdevtools/review_helpers/review.py

@@ -15,9 +15,10 @@
 class ReviewHelper:
   """Helper for conducting code reviews."""
 
+  _SUPPORTED_PROJECTS_PATTERN = '|'.join(
+      project.ProjectHelper.SUPPORTED_PROJECTS)
   _PROJECT_NAME_PREFIX_REGEX = re.compile(
-      r'\[({0:s})\] '.format(
-          '|'.join(project.ProjectHelper.SUPPORTED_PROJECTS)))
+      rf'\[({_SUPPORTED_PROJECTS_PATTERN})\] ')
 
   _CODE_INSPECTION_COMMANDS = frozenset([
       'create-pr', 'create_pr', 'lint', 'lint-test', 'lint_test'])
@@ -66,32 +67,32 @@ def CheckLocalGitState(self):
       if self._command in (
           'close', 'create-pr', 'create_pr', 'lint', 'lint-test', 'lint_test'):
         if not self._git_helper.CheckHasProjectUpstream():
-          print('{0:s} aborted - missing project upstream.'.format(
-              self._command.title()))
-          print('Run: git remote add upstream {0:s}'.format(self._git_repo_url))
+          command_title = self._command.title()
+          print(f'{command_title:s} aborted - missing project upstream.')
+          print(f'Run: git remote add upstream {self._git_repo_url:s}')
           return False
 
     if self._command not in (
         'lint', 'lint-test', 'lint_test', 'test', 'update-version',
         'update_version'):
       if self._git_helper.CheckHasUncommittedChanges():
-        print('{0:s} aborted - detected uncommitted changes.'.format(
-            self._command.title()))
+        command_title = self._command.title()
+        print(f'{command_title:s} aborted - detected uncommitted changes.')
         print('Run: git commit')
         return False
 
     if self._github_organization in ('ForensicArtifacts', 'log2timeline'):
       self._active_branch = self._git_helper.GetActiveBranch()
       if self._command in ('create-pr', 'create_pr'):
         if self._active_branch == 'main':
-          print('{0:s} aborted - active branch is main.'.format(
-              self._command.title()))
+          command_title = self._command.title()
+          print(f'{command_title:s} aborted - active branch is main.')
           return False
 
       elif self._command == 'close':
         if self._feature_branch == 'main':
-          print('{0:s} aborted - feature branch cannot be main.'.format(
-              self._command.title()))
+          command_title = self._command.title()
+          print(f'{command_title:s} aborted - feature branch cannot be main.')
           return False
 
         if self._active_branch != 'main':
@@ -107,14 +108,15 @@ def Close(self):
       bool: True if the close was successful.
     """
     if not self._git_helper.CheckHasBranch(self._feature_branch):
-      print('No such feature branch: {0:s}'.format(self._feature_branch))
+      print(f'No such feature branch: {self._feature_branch:s}')
     else:
       self._git_helper.RemoveFeatureBranch(self._feature_branch)
 
     if not self._git_helper.SynchronizeWithUpstream():
-      print((
-          '{0:s} aborted - unable to synchronize with '
-          'upstream/main.').format(self._command.title()))
+      command_title = self._command.title()
+      print(
+          f'{command_title:s} aborted - unable to synchronize with '
+          f'upstream/main.')
 
     return True
 
@@ -130,8 +132,8 @@ def InitializeHelpers(self):
 
     self._project_name = self._project_helper.project_name
     if not self._project_name:
-      print('{0:s} aborted - unable to determine project name.'.format(
-          self._command.title()))
+      command_title = self._command.title()
+      print(f'{command_title:s} aborted - unable to determine project name.')
       return False
 
     project_definition = self._project_helper.ReadDefinitionFile()
@@ -144,12 +146,15 @@ def InitializeHelpers(self):
       self._github_organization, _, _ = self._github_organization.partition('/')
 
     if not self._github_organization:
-      print('{0:s} aborted - unable to determine GitHub organization.'.format(
-          self._command.title()))
+      command_title = self._command.title()
+      print(
+          f'{command_title:s} aborted - unable to determine GitHub '
+          f'organization.')
       return False
 
-    self._git_repo_url = 'https://github.com/{0:s}/{1:s}.git'.format(
-        self._github_organization, self._project_name)
+    self._git_repo_url = (
+        f'https://github.com/'
+        f'{self._github_organization:s}/{self._project_name:s}.git')
 
     self._git_helper = git.GitHelper(self._git_repo_url)
 
@@ -172,8 +177,11 @@ def Lint(self):
 
     pylint_helper = pylint.PylintHelper()
     if not pylint_helper.CheckUpToDateVersion():
-      print('{0:s} aborted - pylint version {1:s} or later required.'.format(
-          self._command.title(), pylint.PylintHelper.MINIMUM_VERSION))
+      command_title = self._command.title()
+      min_version = pylint.PylintHelper.MINIMUM_VERSION
+      print(
+          f'{command_title:s} aborted - pylint version {min_version:s} '
+          f'or later required.')
       return False
 
     if self._all_files:
@@ -186,8 +194,8 @@ def Lint(self):
 
     pylint_configuration = pylint_helper.GetRCFile(self._project_path)
     if not pylint_helper.CheckFiles(changed_python_files, pylint_configuration):
-      print('{0:s} aborted - unable to pass linter.'.format(
-          self._command.title()))
+      command_title = self._command.title()
+      print(f'{command_title:s} aborted - unable to pass linter.')
 
       return False
 
@@ -208,11 +216,11 @@ def Test(self):
 
     # TODO: determine why this alters the behavior of argparse.
     # Currently affects this script being used in plaso.
-    command = '{0:s} run_tests.py'.format(sys.executable)
+    command = f'{sys.executable:s} run_tests.py'
     exit_code = subprocess.call(command, shell=True)
     if exit_code != 0:
-      print('{0:s} aborted - unable to pass review.'.format(
-          self._command.title()))
+      command_title = self._command.title()
+      print(f'{command_title:s} aborted - unable to pass review.')
 
       return False
 

l2tdevtools/review_helpers/url_lib.py

@@ -39,12 +39,10 @@ def Request(self, url, post_data=None):
 
     except urllib_error.HTTPError as exception:
       raise errors.ConnectivityError(
-          'Failed requesting URL {0:s} with error: {1!s}'.format(
-              url, exception))
+          f'Failed requesting URL {url:s} with error: {exception!s}')
 
     if response_code not in (200, 201):
       raise errors.ConnectivityError(
-          'Failed requesting URL {0:s} with status code: {1:d}'.format(
-              url, response_code))
+          f'Failed requesting URL {url:s} with status code: {response_code:d}')
 
     return page_content

l2tdevtools/source_helper.py

@@ -66,7 +66,7 @@ def __init__(self, project_name, project_definition):
   def Clean(self):
     """Removes a previous version of the source directory."""
     if os.path.exists(self.project_name):
-      logging.info('Removing: {0:s}'.format(self.project_name))
+      logging.info(f'Removing: {self.project_name:s}')
       shutil.rmtree(self.project_name)
 
   def Create(self):