Convert string.format() to f-strings

Author: deathaxe

latextools/auto_label.py

@@ -110,17 +110,17 @@ def run(self, edit):
             # else insert the label as it is
             if len(view.sel()) == 1:
                 snippet = (
-                    "{before_text}"  # leading \label{
-                    "${{1:{label_type}}}:${{2:{label_content}}}"
-                    "{after_text}"  # trailing }
-                    "$0".format(**locals())
+                    f"{before_text}"  # leading \label{
+                    f"${{1:{label_type}}}:${{2:{label_content}}}"
+                    f"{after_text}"   # trailing }
+                    "$0"
                 )
                 view.run_command("insert_snippet", {"contents": snippet})
             else:
                 content = (
-                    "{before_text}"  # leading \label{
-                    "{label_type}:{label_content}"
-                    "{after_text}".format(**locals())  # trailing }
+                    f"{before_text}"  # leading \label{
+                    f"{label_type}:{label_content}"
+                    f"{after_text}"   # trailing }
                 )
                 view.insert(edit, pos, content)
 

latextools/biblatex_name_completions.py

@@ -48,8 +48,8 @@ def _get_replacement(matcher, key):
 
     if matcher.group("ENTRIES").startswith("dna"):
         if match.startswith(" "):
-            return "{0}".format(key)
-        return " {0}".format(key)
+            return str(key)
+        return f" {key}"
     else:
         return "{0}{1}".format(" " if matcher.group("ENTRIES").startswith(" ") != " " else "", key)
 

latextools/change_environment.py

@@ -97,7 +97,7 @@ def extract_end_region(region):
         elif one_sel:
             sublime.status_message(
                 "The environment begin and end does not match:"
-                "'{0}' and '{1}'".format(view.substr(begin_region), view.substr(end_region))
+                f" '{view.substr(begin_region)}' and '{view.substr(end_region)}'"
             )
     if not new_regions:
         sublime.status_message("Environment detection failed")

latextools/context_provider.py

@@ -53,7 +53,7 @@ def on_query_context(self, view, key, operator, operand, match_all):
         except IndexError:
             return False
         except AttributeError:
-            logger.error("Unsupported LaTeXTools context: %s", key)
+            logger.error(f"Unsupported LaTeXTools context: {key}")
             return False
 
         try:
@@ -160,8 +160,8 @@ def _inside_envs(self, view, pos, envs):
                 env.endswith("*"): r"\*",
             }.get(True, r"\*?")
             env = env.rstrip("*!")
-            benv = r"\\begin(?:\[[^\]]\])?{{{}{}}}".format(env, star)
-            eenv = r"\\end{{{}{}}}".format(env, star)
+            benv = fr"\\begin(?:\[[^\]]\])?{{{env}{star}}}"
+            eenv = fr"\\end{{{env}{star}}}"
 
             if only_nearest:
                 real_benv = benv

latextools/delete_temp_files.py

@@ -53,7 +53,7 @@ def latextools_plugin_loaded():
                 except OSError:
                     pass
                 else:
-                    logger.info("Deleted old temp directory %s", directory)
+                    logger.info(f"Deleted old temp directory {directory}")
         except KeyError:
             pass
 
@@ -70,7 +70,7 @@ def run(self):
         except FileNotFoundError:
             pass
         except OSError as e:
-            logger.error("Can't delete global cache: %s", e)
+            logger.error(f"Can't delete global cache: {e}")
 
         tex_root = get_tex_root(self.window.active_view())
         if not tex_root:
@@ -120,7 +120,7 @@ def run(self):
             return
 
         if not os.path.isfile(root_file):
-            message = "Could not find TEX root {0}.".format(root_file)
+            message = f"Could not find TEX root {root_file}."
             sublime.status_message(message)
             logger.error(message)
             return
@@ -227,7 +227,7 @@ def _rmtree(self, path):
             pass
         except OSError:
             # report the exception if the folder didn't end up deleted
-            logger.error("Error while trying to delete %s", path)
+            logger.error(f"Error while trying to delete {path}")
             traceback.print_exc()
 
     def _rmfile(self, path):
@@ -238,7 +238,7 @@ def _rmfile(self, path):
         except OSError:
             # basically here for locked files in Windows,
             # but who knows what we might find?
-            logger.error("Error while trying to delete %s", path)
+            logger.error(f"Error while trying to delete {path}")
             traceback.print_exc()
 
     def _clear_dir(self, path):

latextools/detect_spellcheck.py

@@ -152,13 +152,13 @@ def update_dict_language(view, extract_from_root):
         user_sc = get_setting("tex_spellcheck_paths", {}, view)
         dict_path = user_sc.get(loc) or get_dict_path(loc)
     except DictMissing:
-        logger.error("dict definition missing for locale '%s'", loc)
+        logger.error(f"dict definition missing for locale '{loc}'")
         return  # no dict defined for locale
     current_dict = view.settings().get("dictionary")
     if current_dict == dict_path:
         return  # the locale is already set
     view.settings().set("dictionary", dict_path)
-    logger.info("Changed dictionary to '%s'", dict_path)
+    logger.info(f"Changed dictionary to '{dict_path}'")
 
 
 class LatextoolsAutoDetectSpellcheckListener(sublime_plugin.EventListener):

latextools/jumpto_anywhere.py

@@ -77,7 +77,7 @@ def is_correct_ref(c):
     refs = list(ana.filter_commands(is_correct_ref))
 
     if len(refs) == 0:
-        sublime.error_message("No references for '{0}' found.".format(args))
+        sublime.error_message(f"No references for '{args}' found.")
         return
     elif len(refs) == 1:
         ref = refs[0]
@@ -93,7 +93,7 @@ def _jumpto_ref(view, com_reg, pos):
     label_id = _get_selected_arg(view, com_reg, pos)
     if not label_id:
         return
-    sublime.status_message("Scanning document for label '{0}'...".format(label_id))
+    sublime.status_message(f"Scanning document for label '{label_id}'...")
     tex_root = get_tex_root(view)
     ana = analysis.analyze_document(tex_root)
     if ana is None:
@@ -106,12 +106,12 @@ def is_correct_label(c):
     try:
         label = next(labels)
     except Exception:
-        message = "No matching label found for '{0}'.".format(label_id)
+        message = f"No matching label found for '{label_id}'."
         logger.error(message)
         sublime.status_message(message)
         return
     label_region = label.region
-    message = "Jumping to label '{0}'.".format(label_id)
+    message = f"Jumping to label '{label_id}'"
     logger.info(message)
     sublime.status_message(message)
     utils.open_and_select_region(view, label.file_name, label_region)
@@ -122,7 +122,7 @@ def _jumpto_cite(view, com_reg, pos):
     bib_key = _get_selected_arg(view, com_reg, pos)
     if tex_root is None or not bib_key:
         return
-    message = "Scanning bibliography files for key '{0}'...".format(bib_key)
+    message = f"Scanning bibliography files for key '{bib_key}'..."
     logger.info(message)
     sublime.status_message(message)
     base_dir = os.path.dirname(tex_root)
@@ -146,15 +146,15 @@ def _jumpto_cite(view, com_reg, pos):
                 ):
                     continue
                 region = sublime.Region(start, end)
-                message = "Jumping to bibliography key '{0}'.".format(bib_key)
+                message = f"Jumping to bibliography key '{bib_key}'."
                 logger.info(message)
                 sublime.status_message(message)
                 utils.open_and_select_region(view, bib_file, region)
                 return
             except Exception as e:
-                logger.error("Failed to open file %s:\n  %s", bib_file, e)
+                logger.error(f"Failed to open file {bib_file}:\n  {e}")
                 continue
-    message = "Entry '{0}' not found in bibliography.".format(bib_key)
+    message = f"Entry '{bib_key}' not found in bibliography."
     logger.error(message)
     sublime.status_message(message)
 
@@ -173,19 +173,19 @@ def _jumpto_glo(view, com_reg, pos, acr=False):
     try:
         entry = next(c for c in commands if c.args == iden)
     except Exception:
-        message = "Glossary definition not found for '{0}'".format(iden)
+        message = f"Glossary definition not found for '{iden}'"
         logger.error(message)
         sublime.status_message(message)
         return
-    message = "Jumping to Glossary '{0}'.".format(iden)
+    message = f"Jumping to Glossary '{iden}'."
     logger.info(message)
     sublime.status_message(message)
     utils.open_and_select_region(view, entry.file_name, entry.args_region)
 
 
 def _jumpto_pkg_doc(view, com_reg, pos):
     def view_doc(package):
-        message = "Try opening documentation for package '{0}'".format(package)
+        message = f"Try opening documentation for package '{package}'"
         logger.info(message)
         sublime.status_message(message)
         view.window().run_command("latextools_view_doc", {"file": package})
@@ -215,10 +215,10 @@ def _opt_jumpto_self_def_command(view, com_reg):
     cana = analysis.get_analysis(tex_root)
     new_commands = cana.filter_commands(newcommand_keywords)
     if command not in [c.args for c in new_commands]:
-        logger.error("Command not defined (cached) '%s'", command)
+        logger.error(f"Command not defined (cached) '{command}'")
         return False
 
-    message = "Scanning document for command definition of '{0}'".format(command)
+    message = f"Scanning document for command definition of '{command}'"
     logger.info(message)
     sublime.status_message(message)
     # analyze the document to retrieve the correct position of the
@@ -228,12 +228,12 @@ def _opt_jumpto_self_def_command(view, com_reg):
     try:
         new_com_def = next(filter(lambda c: c.args == command, new_commands))
     except Exception:
-        logger.error("Command not self defined '%s'", command)
+        logger.error(f"Command not self defined '{command}'")
         return False
     file_name = new_com_def.file_name
     region = new_com_def.args_region
 
-    message = "Jumping to definition of '{0}'".format(command)
+    message = f"Jumping to definition of '{command}'"
     logger.info(message)
     sublime.status_message(message)
     utils.open_and_select_region(view, file_name, region)
@@ -291,23 +291,23 @@ def is_inside(g):
         pos = sel.b - line_r.begin() - com_reg.start()
         # check if its a ref
         if NEW_STYLE_REF_REGEX.match(reversed_command):
-            sublime.status_message("Jump to reference '{0}'".format(args))
+            sublime.status_message(f"Jump to reference '{args}'")
             _jumpto_ref(view, com_reg, pos)
         # check if it is a cite
         elif NEW_STYLE_CITE_REGEX.match(reversed_command):
-            sublime.status_message("Jump to citation '{0}'".format(args))
+            sublime.status_message(f"Jump to citation '{args}'")
             _jumpto_cite(view, com_reg, pos)
         elif command == "label":
             _show_usage_label(view, args)
         elif GLO_LINE_RE.match(reversed_command):
-            sublime.status_message("Jump to glossary '{0}'".format(args))
+            sublime.status_message(f"Jump to glossary '{args}'")
             _jumpto_glo(view, com_reg, pos)
         elif ACR_LINE_RE.match(reversed_command):
-            sublime.status_message("Jump to acronym '{0}'".format(args))
+            sublime.status_message(f"Jump to acronym '{args}'")
             _jumpto_glo(view, com_reg, pos, acr=True)
         # check if it is any kind of input command
         elif any(reg.match(com_reg.group(0)) for reg in INPUT_REG_EXPS):
-            sublime.status_message("Jump to file '{0}'".format(args))
+            sublime.status_message(f"Jump to file '{args}'")
             self.view.run_command(
                 "latextools_jumpto_file",
                 {
@@ -345,7 +345,7 @@ def match_selector(selector):
         elif fallback_command:
             if set_caret:
                 self._set_caret(event)
-            logger.debug("Run command '%s'", fallback_command)
+            logger.debug(f"Run command '{fallback_command}'")
             self.view.run_command(fallback_command)
 
     def _set_caret(self, event):

latextools/jumpto_pdf.py

@@ -42,16 +42,14 @@ def get_viewer():
         raise NoViewerException()
 
     try:
-        viewer = get_plugin(viewer_name + "_viewer")
+        viewer = get_plugin(f"{viewer_name}_viewer")
     except NoSuchPluginException:
         try:
             viewer = get_plugin(viewer_name)
         except NoSuchPluginException:
             sublime.error_message(
-                "Cannot find viewer "
-                + viewer_name
-                + ".\n"
-                + "Please check your LaTeXTools Preferences."
+                f"Cannot find viewer {viewer_name}.\n"
+                "Please check your LaTeXTools Preferences."
             )
             raise NoViewerException()
 
@@ -62,7 +60,7 @@ def get_viewer():
 
     if not viewer.supports_platform(sublime.platform()):
         sublime.error_message(
-            viewer_name + " does not support the current platform. "
+            f"{viewer_name} does not support the current platform. "
             "Please change the viewer in your LaTeXTools Preferences."
         )
         raise NoViewerException()
@@ -102,19 +100,13 @@ def run(self, **args):
         if from_keybinding:
             forward_sync = True
 
-        logger.debug(
-            "from_keybinding=%s, keep_focus=%s, forward_sync=%s",
-            from_keybinding,
-            keep_focus,
-            forward_sync,
-        )
+        logger.debug(f"from_keybinding={from_keybinding}, keep_focus={keep_focus}, forward_sync={forward_sync}")
 
         file_name = view.file_name()
         if not is_tex_file(file_name):
             if from_keybinding:
-                sublime.error_message(
-                    "%s is not a TeX source file: cannot jump." % (os.path.basename(file_name),)
-                )
+                file_name = os.path.basename(file_name) if file_name else 'untitled'
+                sublime.error_message(f"{file_name} is not a TeX source file: cannot jump.")
                 return
             # If not invoked from keybinding, it is invoked by the
             # compilation process. Then, we should go forward with
@@ -136,13 +128,13 @@ def run(self, **args):
                 pdffile = os.path.join(os.path.dirname(root), file_name + ".pdf")
 
         if not os.path.exists(pdffile):
-            logger.error("Expected PDF file %s not found", pdffile)
+            logger.error(f"Expected PDF file {pdffile} not found")
             return
 
         pdffile = os.path.realpath(pdffile)
 
         (row, col) = view.rowcol(view.sel()[0].end())
-        logger.debug("Jump to row: %d col: %d", row, col)
+        logger.debug(f"Jump to row: {row} col: {col}")
         # column is actually ignored up to 0.94
         # HACK? It seems we get better results incrementing row
         row += 1
@@ -224,7 +216,7 @@ def run(self, **args):
 
         pdffile = os.path.normpath(pdffile)
         if not os.path.exists(pdffile):
-            logger.error("Expected PDF file %s not found", pdffile)
+            logger.error(f"Expected PDF file {pdffile} not found")
             return
 
         pdffile = os.path.realpath(pdffile)
@@ -236,7 +228,7 @@ def run(self, **args):
             return
         elif not os.path.exists(pdffile):
             # note: error_message() already logs to console
-            sublime.error_message('PDF file "{0}" does not exist.'.format(pdffile))
+            sublime.error_message(f'PDF file "{pdffile}" does not exist.')
             return
 
         try: