chore: cleanup string.format to f-strings (#432)

dandhlee · web-flow · commit e5e33ad20431 · 2025-11-04T12:31:57.000-08:00
* chore: cleanup string.format to f-strings

* chore: fix cases where fstrings are not possible
diff --git a/packages/gcp-sphinx-docfx-yaml/docfx_yaml/extension.py b/packages/gcp-sphinx-docfx-yaml/docfx_yaml/extension.py
@@ -355,7 +355,7 @@ def _resolve_reference_in_module_summary(pattern, lines):
 
             # Check to see if we should create an xref for it.
             if 'google.cloud' in matched_str:
-                new_line = new_line.replace(matched_str, '<xref uid=\"{}\">{}</xref>'.format(xref, ref_name))
+                new_line = new_line.replace(matched_str, f'<xref uid="{xref}">{ref_name}</xref>')
             # If it not a Cloud library, don't create xref for it.
             else:
                 # Carefully extract the original uid
@@ -364,7 +364,7 @@ def _resolve_reference_in_module_summary(pattern, lines):
                     ref_name = matched_str[index+1:-1]
                 else:
                     ref_name = matched_str[1:]
-                new_line = new_line.replace(matched_str, '`{}`'.format(ref_name))
+                new_line = new_line.replace(matched_str, f'`{ref_name}`')
 
         new_lines.append(new_line)
     return new_lines, xrefs
@@ -602,8 +602,7 @@ def _parse_docstring_summary(
 
             # Extracts the notice content and format it.
             elif keyword and keyword in NOTICES:
-                summary_parts.append(notice_open_tag.format(
-                    notice_tag=keyword, notice_name=NOTICES[keyword]))
+                summary_parts.append(f'<aside class="{keyword}">\n<b>{NOTICES[keyword]}:</b>')
                 tab_space = -1
                 notice_body = []
                 parts = [split_part for split_part in part.split("\n") if split_part][1:]
@@ -1019,12 +1018,12 @@ def _update_friendly_package_name(path):
                     lines = inspect.getdoc(obj)
                     lines = lines.split("\n") if lines else []
             except TypeError as e:
-                print("couldn't getdoc from method, function: {}".format(e))
+                print(f"couldn't getdoc from method, function: {e}")
         elif _type in [PROPERTY]:
             lines = inspect.getdoc(obj)
             lines = lines.split("\n") if lines else []
     except TypeError as e:
-        print("Can't get argspec for {}: {}. {}".format(type(obj), name, e))
+        print(f"Can't get argspec for {type(obj)}: {name}. {e}")
 
     if name in app.env.docfx_signature_funcs_methods:
         sig = app.env.docfx_signature_funcs_methods[name]
@@ -1064,9 +1063,9 @@ def _update_friendly_package_name(path):
     except (TypeError, OSError):
         # TODO: remove this once there is full handler for property
         if _type in [PROPERTY]:
-            print("Skip inspecting for property: {}".format(name))
+            print(f"Skip inspecting for property: {name}")
         else:
-            print("Can't inspect type {}: {}".format(type(obj), name))
+            print(f"Can't inspect type {type(obj)}: {name}")
         path = None
         start_line = None
 
@@ -1246,11 +1245,11 @@ def process_docstring(app, _type, name, obj, options, lines):
 
     if _type == FUNCTION and app.config.autodoc_functions:
         if datam['uid'] is None:
-            raise ValueError("Issue with {0} (name={1})".format(datam, name))
+            raise ValueError(f"Issue with {datam} (name={name})")
         if cls is None:
             cls = name
         if cls is None:
-            raise ValueError("cls is None for name='{1}' {0}".format(datam, name))
+            raise ValueError(f"cls is None for name='{name}' {datam}")
         if cls not in app.env.docfx_yaml_functions:
             app.env.docfx_yaml_functions[cls] = [datam]
         else:
diff --git a/packages/gcp-sphinx-docfx-yaml/docfx_yaml/extract_nodes.py b/packages/gcp-sphinx-docfx-yaml/docfx_yaml/extract_nodes.py
@@ -135,7 +135,7 @@ def extract_yaml(app, doctree, ignore_patterns):
         try:
             uid = desc_node[0].attributes['ids'][0]
         except Exception:
-            uid = '{module}.{full_name}'.format(module=module, full_name=full_name)
+            uid = f'{module}.{full_name}'
             print('Non-standard id: %s' % uid)
         name = desc_node[0].attributes['names'][0]
         source = desc_node[0].source
@@ -150,7 +150,7 @@ def extract_yaml(app, doctree, ignore_patterns):
             args = []
 
         if args:
-            full_name += "({args})".format(args=', '.join(args))
+            full_name += f"({', '.join(args)})"
 
         datam = {
             'module': str(module),
diff --git a/packages/gcp-sphinx-docfx-yaml/docfx_yaml/monkeypatch.py b/packages/gcp-sphinx-docfx-yaml/docfx_yaml/monkeypatch.py
@@ -45,7 +45,7 @@ def _get_desc_data(node):
     try:
         uid = node[0].attributes['ids'][0]
     except Exception:
-        uid = '{module}.{full_name}'.format(module=module, full_name=full_name)
+        uid = f'{module}.{full_name}'
         print('Non-standard id: %s' % uid)
     return full_name, uid
 
diff --git a/packages/gcp-sphinx-docfx-yaml/docfx_yaml/writer.py b/packages/gcp-sphinx-docfx-yaml/docfx_yaml/writer.py
@@ -581,8 +581,8 @@ def depart_table(self, node):
         colwidths = self.table[0]
         realwidths = colwidths[:]
         separator = 0
-        self.add_text('<!-- {} -->'.format(node.tagname))
-        # self.add_text('<!-- {} -->'.format(json.dumps(self.table)))
+        self.add_text(f'<!-- {node.tagname} -->')
+        # self.add_text(f'<!-- {json.dumps(self.table)} -->')
 
         # don't allow paragraphs in table cells for now
         # for line in lines:
@@ -642,13 +642,13 @@ def visit_image(self, node):
         try:
             image_name = '/'.join(node.attributes['uri'].split('/')[node.attributes['uri'].split('/').index('_static')-1:])
         except ValueError as e:
-            print("Image not found where expected {}".format(node.attributes['uri']))
+            print(f"Image not found where expected {node.attributes['uri']}")
             raise nodes.SkipNode
         image_name = ''.join(image_name.split())
         self.new_state(0)
         if 'alt' in node.attributes:
-            self.add_text('![{}]({})'.format(node['alt'], image_name) + self.nl)
-        self.add_text('![image]({})'.format(image_name) + self.nl)
+            self.add_text(f'![{node["alt"]}]({image_name})' + self.nl)
+        self.add_text(f'![image]({image_name})' + self.nl)
         self.end_state(False)
         raise nodes.SkipNode
 
@@ -793,7 +793,7 @@ def depart_alert_box(self, node):
             self.clear_last_state()
             MarkdownTranslator.resolve_reference_in_node(node)
             lines = node.astext().split('\n')
-            quoteLines = ['> {0}\n>'.format(line) for line in lines]
+            quoteLines = [f'> {line}\n>' for line in lines]
             mdStr = '\n> [!{0}]\n{1}'.format(name, '\n'.join(quoteLines))
             self.add_text(mdStr)
         return depart_alert_box
@@ -849,18 +849,18 @@ def visit_literal_block(self, node):
             include_language = (('-' + include_language) if (include_language is not None) else '')
             include_caption = (('"' + include_caption + '"') if (include_caption is not None) else '')
 
-            self.add_text('<!--[!code{}[Main]({} {})]-->'.format(include_language, relative_path, include_caption))
+            self.add_text(f'<!--[!code{include_language}[Main]({relative_path} {include_caption})]-->')
         except KeyError as e:
             pass
         except ValueError as e:
             pass
 
         self.new_state(0)
-        self.add_text('<!-- {} {} -->'.format(node.tagname, json.dumps(node.attributes)))
+        self.add_text(f'<!-- {node.tagname} {json.dumps(node.attributes)} -->')
         self.end_state(wrap=False)
 
         if 'language' in node.attributes:
-            self.add_text('````{}'.format(node.attributes['language']))
+            self.add_text(f'````{node.attributes["language"]}')
         else:
             self.add_text('````')
         self.new_state()
@@ -919,7 +919,7 @@ def depart_paragraph(self, node):
     def visit_target(self, node):
         if node.hasattr('refid'):
             self.new_state(0)
-            self.add_text('<a name={}></a>'.format(node.attributes['refid']))
+            self.add_text(f'<a name={node.attributes["refid"]}></a>')
             self.end_state()
         raise nodes.SkipNode
 
@@ -934,7 +934,7 @@ def visit_substitution_definition(self, node):
 
     def visit_pending_xref(self, node):
         if 'refdomain' in node.attributes and node.attributes['refdomain'] == 'py':
-            self.add_text('<xref:{}>'.format(node.attributes['reftarget']))
+            self.add_text(f'<xref:{node.attributes["reftarget"]}>')
         raise nodes.SkipNode
 
     def depart_pending_xref(self, node):
@@ -946,10 +946,10 @@ def _resolve_reference(cls, node):
         raw_ref_tilde_template = ":class:`~{0}`"
         raw_ref_template = ":class:`{0}`"
         if 'refid' in node.attributes:
-            ref_string = cls.xref_template.format(node.attributes['refid'])
+            ref_string = f'<xref:{node.attributes["refid"]}>'
         elif 'refuri' in node.attributes:
             if 'http' in node.attributes['refuri'] or node.attributes['refuri'][0] == '/':
-                ref_string = '[{}]({})'.format(node.astext(), node.attributes['refuri'])
+                ref_string = f'[{node.astext()}]({node.attributes["refuri"]})'
             else:
                 # only use id in class and func refuri if its id exists
                 # otherwise, remove '.html#' in refuri
@@ -971,7 +971,7 @@ def _resolve_reference(cls, node):
                 else:
                     ref_string = cls.xref_template.format(node.attributes['refuri'])
         else:
-            ref_string = '{}<!-- {} -->'.format(node.tagname, json.dumps(node.attributes))
+            ref_string = f'{node.tagname}<!-- {json.dumps(node.attributes)} -->'
 
         return ref_string
 
@@ -1126,4 +1126,4 @@ def depart_substitution_reference(self, node):
     depart_remarks = remarks.depart_remarks
 
     def unknown_visit(self, node):
-        raise NotImplementedError('Unknown node: ' + node.__class__.__name__)
+        raise NotImplementedError('Unknown node: ' + node.__class__.__name__)
