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

Author: joachimmetz

data/presets.ini

@@ -7,7 +7,7 @@ presets: dfvfs,dfwinreg
 projects: artifacts,dfimagetools
 
 [dfvfs]
-projects: cffi,dfdatetime,dfvfs,dtfabric,libcaes,libbde,libewf,libfcrypto,libfsapfs,libfsext,libfsfat,libfshfs,libfsntfs,libfsxfs,libfvde,libfwnt,libgzipf,libluksde,libmodi,libphdi,libqcow,libsigscan,libsmdev,libsmraw,libvhdi,libvmdk,libvsapm,libvsbsdl,libvsgpt,libvshadow,libvslvm,pbr,pytsk3,PyYAML,xattr
+projects: dfdatetime,dfvfs,dtfabric,libcaes,libbde,libewf,libfcrypto,libfsapfs,libfsext,libfsfat,libfshfs,libfsntfs,libfsxfs,libfvde,libfwnt,libgzipf,libluksde,libmodi,libphdi,libqcow,libsigscan,libsmdev,libsmraw,libvhdi,libvmdk,libvsapm,libvsbsdl,libvsgpt,libvshadow,libvslvm,pbr,pytsk3,PyYAML,xattr
 
 [dfwinreg]
 projects: dfdatetime,dfwinreg,dtfabric,libcreg,libregf,pbr,PyYAML
@@ -33,7 +33,7 @@ projects: libbde,libcaes,libcdata,libcdatetime,libcdirectory,libcerror,libcfile,
 
 [plaso]
 presets: dfimagetools
-projects: acstore,bencode,certifi,cffi,chardet,dateutil,defusedxml,fakeredis,Flor,idna,libcaes,libesedb,libevt,libevtx,libexe,libfwps,libfwsi,liblnk,libmsiecf,libolecf,libscca,opensearch-py,pbr,pefile,plaso,psutil,pyparsing,python-lz4,python-zstd,pytz,pyzmq,redis-py,requests,urllib3,XlsxWriter,yara-python
+projects: acstore,bencode,certifi,chardet,dateutil,defusedxml,fakeredis,Flor,libcaes,libesedb,libevt,libevtx,libexe,libfwps,libfwsi,liblnk,libmsiecf,libolecf,libscca,opensearch-py,pbr,pefile,plaso,psutil,pyparsing,python-lz4,python-zstd,pytz,pyzmq,redis-py,requests,urllib3,XlsxWriter,yara-python
 
 [timesketch]
 projects: alembic,altair,amqp,aniso8601,asn1crypto,attrs,bcrypt,beautifulsoup4,billiard,blinker,celery,certifi,cffi,chardet,ciso8601,Click,cryptography,datasketch,dateutil,entrypoints,Flask,Flask-Bcrypt,Flask-Migrate,Flask-Login,Flask-RESTful,Flask-Script,Flask-SQLAlchemy,Flask-WTF,google-auth,google-auth-oauthlib,gunicorn,importlib-metadata,idna,itsdangerous,Jinja2,jsonschema,kombu,Mako,Markdown,MarkupSafe,networkx,numpy,oauthlib,opensearch-py,pandas,parameterized,prometheus_flask_exporter,pycparser,PyJWT,pyrsistent,python-editor,pytz,PyYAML,redis-py,requests,requests-oauthlib,sigmatools,SQLAlchemy,tabulate,timesketch,toolz,urllib3,vine,Werkzeug,WTForms,xlrd,xmltodict

data/templates/check_dependencies-with_url.py

@@ -15,9 +15,9 @@
 
   if not dependency_helper.CheckDependencies():
     build_instructions_url = (
-        'https://plaso.readthedocs.io/en/latest/sources/user/Users-Guide.html')
+        'https://${project_name}.readthedocs.io/en/latest/sources/user/Users-Guide.html')
 
-    print('See: {0:s} on how to set up ${project_name}.'.format(build_instructions_url))
+    print(f'See: {build_instructions_url:s} on how to set up ${project_name}.')
     print('')
 
     sys.exit(1)

data/templates/dependencies.py

@@ -44,15 +44,15 @@ def _CheckPythonModule(
   module_object = _ImportPythonModule(module_name)
   if not module_object:
     if not is_required:
-      print('[OPTIONAL]\tmissing: {0:s}.'.format(module_name))
+      print(f'[OPTIONAL]\tmissing: {module_name:s}.')
       return True
 
-    print('[FAILURE]\tmissing: {0:s}.'.format(module_name))
+    print(f'[FAILURE]\tmissing: {module_name:s}.')
     return False
 
   if not version_attribute_name or not minimum_version:
     if verbose_output:
-      print('[OK]\t\t{0:s}'.format(module_name))
+      print(f'[OK]\t\t{module_name:s}')
     return True
 
   module_version = None
@@ -66,17 +66,17 @@ def _CheckPythonModule(
   if not module_version:
     if not is_required:
       print((
-          '[OPTIONAL]\tunable to determine version information '
-          'for: {0:s}').format(module_name))
+          f'[OPTIONAL]\tunable to determine version information '
+          f'for: {module_name:s}'))
       return True
 
     print((
-        '[FAILURE]\tunable to determine version information '
-        'for: {0:s}').format(module_name))
+        f'[FAILURE]\tunable to determine version information '
+        f'for: {module_name:s}'))
     return False
 
   # Make sure the module version is a string.
-  module_version = '{0!s}'.format(module_version)
+  module_version = f'{module_version!s}'
 
   # Remove a version suffix, such as: 0.7.0~rc1
   module_version_list = _VERSION_SPLIT_REGEX.split(module_version)
@@ -95,13 +95,13 @@ def _CheckPythonModule(
   if module_version_map < minimum_version_map:
     if not is_required:
       print((
-          '[OPTIONAL]\t{0:s} version: {1!s} is too old, {2!s} or later '
-          'required.').format(module_name, module_version, minimum_version))
+          f'[OPTIONAL]\t{module_name:s} version: {module_version!s} is too '
+          f'old, {minimum_version!s} or later required.'))
       return True
 
     print((
-        '[FAILURE]\t{0:s} version: {1!s} is too old, {2!s} or later '
-        'required.').format(module_name, module_version, minimum_version))
+        f'[FAILURE]\t{module_name:s} version: {module_version!s} is too old, '
+        f'{minimum_version!s} or later required.'))
     return False
 
   if maximum_version:
@@ -110,17 +110,17 @@ def _CheckPythonModule(
     if module_version_map > maximum_version_map:
       if not is_required:
         print((
-            '[OPTIONAL]\t{0:s} version: {1!s} is too recent, {2!s} or earlier '
-            'required.').format(module_name, module_version, minimum_version))
+            f'[OPTIONAL]\t{module_name:s} version: {module_version!s} is too '
+            f'recent, {minimum_version!s} or earlier required.'))
         return True
 
       print((
-          '[FAILURE]\t{0:s} version: {1!s} is too recent, {2!s} or earlier '
-          'required.').format(module_name, module_version, maximum_version))
+          f'[FAILURE]\t{module_name:s} version: {module_version!s} is too '
+          f'recent, {maximum_version!s} or earlier required.'))
       return False
 
   if verbose_output:
-    print('[OK]\t\t{0:s} version: {1!s}'.format(module_name, module_version))
+    print(f'[OK]\t\t{module_name:s} version: {module_version!s}')
 
   return True
 

l2tdevtools/build_helpers/interface.py

@@ -36,15 +36,14 @@ def _RemoveOlderSourceDirectories(self, project_name, project_version):
       project_name (str): name of the project.
       project_version (str): version of the project.
     """
-    filenames_to_ignore = re.compile(
-        '^{0:s}-.*{1!s}'.format(project_name, project_version))
+    filenames_to_ignore = re.compile(f'^{project_name:s}-.*{project_version!s}')
 
     # Remove previous versions of source directories in the format:
     # <project>-[0-9]*
-    filenames = glob.glob('{0:s}-[0-9]*'.format(project_name))
+    filenames = glob.glob(f'{project_name:s}-[0-9]*')
     for filename in filenames:
       if os.path.isdir(filename) and not filenames_to_ignore.match(filename):
-        logging.info('Removing: {0:s}'.format(filename))
+        logging.info(f'Removing: {filename:s}')
         shutil.rmtree(filename, ignore_errors=True)
 
   def _RemoveOlderSourcePackages(self, project_name, project_version):
@@ -54,31 +53,30 @@ def _RemoveOlderSourcePackages(self, project_name, project_version):
       project_name (str): name of the project.
       project_version (str): version of the project.
     """
-    filenames_to_ignore = re.compile(
-        '^{0:s}-.*{1!s}'.format(project_name, project_version))
+    filenames_to_ignore = re.compile(f'^{project_name:s}-.*{project_version!s}')
 
     # Remove previous versions of source packages in the format:
     # <project>-[0-9]*.tar.gz
-    filenames = glob.glob('{0:s}-[0-9]*.tar.gz'.format(project_name))
+    filenames = glob.glob(f'{project_name:s}-[0-9]*.tar.gz')
     for filename in filenames:
       if not filenames_to_ignore.match(filename):
-        logging.info('Removing: {0:s}'.format(filename))
+        logging.info(f'Removing: {filename:s}')
         os.remove(filename)
 
     # Remove previous versions of source packages in the format:
     # <project>-[0-9]*.tgz
-    filenames = glob.glob('{0:s}-[0-9]*.tgz'.format(project_name))
+    filenames = glob.glob(f'{project_name:s}-[0-9]*.tgz')
     for filename in filenames:
       if not filenames_to_ignore.match(filename):
-        logging.info('Removing: {0:s}'.format(filename))
+        logging.info(f'Removing: {filename:s}')
         os.remove(filename)
 
     # Remove previous versions of source packages in the format:
     # <project>-[0-9]*.zip
-    filenames = glob.glob('{0:s}-[0-9]*.zip'.format(project_name))
+    filenames = glob.glob(f'{project_name:s}-[0-9]*.zip')
     for filename in filenames:
       if not filenames_to_ignore.match(filename):
-        logging.info('Removing: {0:s}'.format(filename))
+        logging.info(f'Removing: {filename:s}')
         os.remove(filename)
 
   def CheckBuildDependencies(self):

l2tdevtools/build_helpers/rpm.py

@@ -86,8 +86,9 @@ def _BuildFromSpecFile(self, spec_filename, rpmbuild_flags='-ba'):
     current_path = os.getcwd()
     os.chdir(self.rpmbuild_path)
 
-    command = 'rpmbuild {0:s} {1:s} > {2:s} 2>&1'.format(
-        rpmbuild_flags, spec_filename, self.LOG_FILENAME)
+    command = (
+        f'rpmbuild {rpmbuild_flags:s} {spec_filename:s} > '
+        f'{self.LOG_FILENAME:s} 2>&1')
     exit_code = subprocess.call(command, shell=True)
     if exit_code != 0:
       logging.error(f'Running: "{command:s}" failed.')
@@ -109,8 +110,9 @@ def _BuildFromSourcePackage(
     Returns:
       bool: True if successful, False otherwise.
     """
-    command = 'rpmbuild {0:s} {1:s} > {2:s} 2>&1'.format(
-        rpmbuild_flags, source_package_filename, self.LOG_FILENAME)
+    command = (
+        f'rpmbuild {rpmbuild_flags:s} {source_package_filename:s} > '
+        f'{self.LOG_FILENAME:s} 2>&1')
     exit_code = subprocess.call(command, shell=True)
     if exit_code != 0:
       logging.error(f'Running: "{command:s}" failed.')
@@ -127,8 +129,8 @@ def _CheckIsInstalled(self, package_name):
     Returns:
       bool: True if the package is installed, False otherwise.
     """
-    command = 'rpm -qi {0:s} >/dev/null 2>&1'.format(package_name)
-    exit_code = subprocess.call(command, shell=True)
+    exit_code = subprocess.call(
+        f'rpm -qi {package_name:s} >/dev/null 2>&1', shell=True)
     return exit_code == 0
 
   def _CopySourcePackageToRPMBuildSources(self, source_package_path):
@@ -266,12 +268,12 @@ def _RemoveOlderBuildDirectory(self, project_name, project_version):
     filenames_to_ignore = re.compile(f'{project_name:s}-{project_version!s}')
 
     filenames_glob = os.path.join(
-        self.rpmbuild_path, 'BUILD', '{0:s}-*'.format(project_name))
+        self.rpmbuild_path, 'BUILD', f'{project_name:s}-*')
     filenames = glob.glob(filenames_glob)
 
     for filename in filenames:
       if not filenames_to_ignore.match(filename):
-        logging.info('Removing: {0:s}'.format(filename))
+        logging.info(f'Removing: {filename:s}')
         shutil.rmtree(filename, ignore_errors=True)
 
   def _RemoveOlderRPMs(self, project_name, project_version):
@@ -281,17 +283,16 @@ def _RemoveOlderRPMs(self, project_name, project_version):
       project_name (str): name of the project.
       project_version (str): version of the project.
     """
-    filenames_to_ignore = '.*{0:s}-.*{1!s}-1.{2:s}.rpm'.format(
-        project_name, project_version, self.architecture)
+    filenames_to_ignore = (
+        f'.*{project_name:s}-.*{project_version!s}-1.{self.architecture:s}.rpm')
     filenames_to_ignore = re.compile(filenames_to_ignore)
 
-    rpm_filenames_glob = '*{0:s}-*-1.{1:s}.rpm'.format(
-        project_name, self.architecture)
+    rpm_filenames_glob = f'*{project_name:s}-*-1.{self.architecture:s}.rpm'
     filenames = glob.glob(rpm_filenames_glob)
 
     for filename in filenames:
       if not filenames_to_ignore.match(filename):
-        logging.info('Removing: {0:s}'.format(filename))
+        logging.info(f'Removing: {filename:s}')
         os.remove(filename)
 
     filenames_glob = os.path.join(
@@ -300,7 +301,7 @@ def _RemoveOlderRPMs(self, project_name, project_version):
 
     for filename in filenames:
       if not filenames_to_ignore.match(filename):
-        logging.info('Removing: {0:s}'.format(filename))
+        logging.info(f'Removing: {filename:s}')
         os.remove(filename)
 
   def CheckBuildRequired(self, source_helper_object):
@@ -315,8 +316,8 @@ def CheckBuildRequired(self, source_helper_object):
     project_name, project_version = self._GetFilenameSafeProjectInformation(
         source_helper_object)
 
-    rpm_filename = '{0:s}-{1!s}-1.{2:s}.rpm'.format(
-        project_name, project_version, self.architecture)
+    rpm_filename = (
+        f'{project_name:s}-{project_version!s}-1.{self.architecture:s}.rpm')
 
     return not os.path.exists(rpm_filename)
 

l2tdevtools/build_helpers/source.py

@@ -25,34 +25,34 @@ def Build(self, source_helper_object):
     Returns:
       bool: True if successful, False otherwise.
     """
+    project_name = source_helper_object.project_name
+
     source_package_path = source_helper_object.GetSourcePackagePath()
     if not source_package_path:
-      logging.info('Missing source package of: {0:s}'.format(
-          source_helper_object.project_name))
+      logging.info(f'Missing source package of: {project_name:s}')
       return False
 
     source_directory = source_helper_object.GetSourceDirectoryPath()
     if not source_directory:
-      logging.info('Missing source directory of: {0:s}'.format(
-          source_helper_object.project_name))
+      logging.info(f'Missing source directory of: {project_name:s}')
       return False
 
     source_package_filename = source_helper_object.GetSourcePackageFilename()
-    logging.info('Building source of: {0:s}'.format(source_package_filename))
+    logging.info(f'Building source of: {source_package_filename:s}')
 
     log_file_path = os.path.join('..', self.LOG_FILENAME)
-    command = './configure > {0:s} 2>&1'.format(log_file_path)
-    exit_code = subprocess.call('(cd {0:s} && {1:s})'.format(
-        source_directory, command), shell=True)
+    command = f'./configure > {log_file_path:s} 2>&1'
+    exit_code = subprocess.call(
+        f'(cd {source_directory:s} && {command:s})', shell=True)
     if exit_code != 0:
-      logging.error('Running: "{0:s}" failed.'.format(command))
+      logging.error(f'Running: "{command:s}" failed.')
       return False
 
-    command = 'make >> {0:s} 2>&1'.format(log_file_path)
-    exit_code = subprocess.call('(cd {0:s} && {1:s})'.format(
-        source_directory, command), shell=True)
+    command = f'make >> {log_file_path:s} 2>&1'
+    exit_code = subprocess.call(
+        f'(cd {source_directory:s} && {command:s})', shell=True)
     if exit_code != 0:
-      logging.error('Running: "{0:s}" failed.'.format(command))
+      logging.error(f'Running: "{command:s}" failed.')
       return False
 
     return True
@@ -80,28 +80,27 @@ def Build(self, source_helper_object):
     Returns:
       bool: True if successful, False otherwise.
     """
+    project_name = source_helper_object.project_name
+
     source_package_path = source_helper_object.GetSourcePackagePath()
     if not source_package_path:
-      logging.info('Missing source package of: {0:s}'.format(
-          source_helper_object.project_name))
+      logging.info(f'Missing source package of: {project_name:s}')
       return False
 
     source_directory = source_helper_object.GetSourceDirectoryPath()
     if not source_directory:
-      logging.info('Missing source directory of: {0:s}'.format(
-          source_helper_object.project_name))
+      logging.info(f'Missing source directory of: {project_name:s}')
       return False
 
     source_package_filename = source_helper_object.GetSourcePackageFilename()
-    logging.info('Building source of: {0:s}'.format(source_package_filename))
+    logging.info(f'Building source of: {source_package_filename:s}')
 
     log_file_path = os.path.join('..', self.LOG_FILENAME)
-    command = '{0:s} setup.py build > {1:s} 2>&1'.format(
-        sys.executable, log_file_path)
-    exit_code = subprocess.call('(cd {0:s} && {1:s})'.format(
-        source_directory, command), shell=True)
+    command = f'{sys.executable:s} setup.py build > {log_file_path:s} 2>&1'
+    exit_code = subprocess.call(
+        f'(cd {source_directory:s} && {command:s})', shell=True)
     if exit_code != 0:
-      logging.error('Running: "{0:s}" failed.'.format(command))
+      logging.error(f'Running: "{command:s}" failed.')
       return False
 
     return True