switch to f-string

Updating various format calls to use f-string instead.

Signed-off-by: James Knight <[email protected]>

Author: jdknight

sphinxcontrib/confluencebuilder/assets.py

@@ -295,7 +295,7 @@ def _handle_entry(self, path, docname, standalone=False):
                 idx = 1
                 while key in self.keys:
                     idx += 1
-                    key = '{}_{}{}'.format(filename, idx, file_ext)
+                    key = f'{filename}_{idx}{file_ext}'
                 self.keys.add(key)
 
                 asset = ConfluenceAsset(key, path, type_, hash_)

sphinxcontrib/confluencebuilder/builder.py

@@ -251,7 +251,7 @@ def prepare_writing(self, docnames):
             for domain_name in sorted(self.env.domains):
                 domain = self.env.domains[domain_name]
                 for indexcls in domain.indices:
-                    indexname = '%s-%s' % (domain.name, indexcls.name)
+                    indexname = f'{domain.name}-{indexcls.name}'
 
                     if isinstance(indices_config, list):
                         if indexname not in indices_config:
@@ -480,7 +480,7 @@ def write_doc(self, docname, doctree):
                     if self.writer.output:
                         file.write(self.writer.output)
             except (IOError, OSError) as err:
-                self.warn('error writing file %s: %s' % (outfilename, err))
+                self.warn(f'error writing file {outfilename}: {err}')
 
     def publish_doc(self, docname, output):
         conf = self.config
@@ -697,7 +697,7 @@ def finish(self):
         # build domain indexes
         if self.domain_indices:
             for indexname, indexdata in self.domain_indices.items():
-                self.info('generating index ({})...'.format(indexname),
+                self.info(f'generating index ({indexname})...',
                     nonl=(not self._verbose))
 
                 self._generate_special_document(indexname,
@@ -737,7 +737,7 @@ def finish(self):
                         self.publish_doc(docname, output)
 
                 except (IOError, OSError) as err:
-                    self.warn('error reading file %s: %s' % (docfile, err))
+                    self.warn(f'error reading file {docfile}: {err}')
 
             self.info('building intersphinx... ', nonl=(not self._verbose))
             build_intersphinx(self)
@@ -768,7 +768,7 @@ def to_asset_name(asset):
                         output = file.read()
                         self.publish_asset(key, docname, output, type_, hash_)
                 except (IOError, OSError) as err:
-                    self.warn('error reading asset %s: %s' % (key, err))
+                    self.warn(f'error reading asset {key}: {err}')
 
             self.publish_cleanup()
             self.publish_finalize()
@@ -866,7 +866,7 @@ def _generate_special_document(self, docname, generator):
                     with open(fname, encoding='utf-8') as file:
                         header_template_data = file.read() + '\n'
                 except (IOError, OSError) as err:
-                    self.warn('error reading file {}: {}'.format(fname, err))
+                    self.warn(f'error reading file {fname}: {err}')
 
                 # if no data is supplied, the file is plain text
                 if self.config.confluence_header_data is None:
@@ -888,7 +888,7 @@ def _generate_special_document(self, docname, generator):
                     with open(fname, encoding='utf-8') as file:
                         footer_template_data = file.read() + '\n'
                 except (IOError, OSError) as err:
-                    self.warn('error reading file {}: {}'.format(fname, err))
+                    self.warn(f'error reading file {fname}: {err}')
 
                 # if no data is supplied, the file is plain text
                 if self.config.confluence_footer_data is None:
@@ -1084,10 +1084,10 @@ def _register_doctree_title_targets(self, docname, doctree):
                     section_id = doc_used_names.get(target, 0)
                     doc_used_names[target] = section_id + 1
                     if section_id > 0:
-                        target = '{}.{}'.format(target, section_id)
+                        target = f'{target}.{section_id}'
 
                     for id_ in section_node['ids']:
-                        id_ = '{}#{}'.format(docname, id_)
+                        id_ = f'{docname}#{id_}'
                         self.state.register_target(id_, target)
 
     def _top_ref_check(self, node):
@@ -1120,7 +1120,7 @@ def _parse_doctree_title(self, docname, doctree):
 
         if not doctitle:
             if not self.config.confluence_disable_autogen_title:
-                doctitle = "autogen-{}".format(docname)
+                doctitle = f'autogen-{docname}'
                 if self.publish:
                     self.warn('document will be published using an '
                         'generated title value: {}'.format(docname))

sphinxcontrib/confluencebuilder/cmd/report.py

@@ -187,7 +187,7 @@ def report_main(args_parser):
                 else:
                     logger.error('bad response from server ({})'.format(
                         rsp.status_code))
-                    info += '   fetched: error ({})\n'.format(rsp.status_code)
+                    info += f'   fetched: error ({rsp.status_code})\n'
                     rv = 1
             except Exception:
                 sys.stdout.flush()
@@ -279,7 +279,7 @@ def sensitive_config(key):
     print('(configuration)')
     if config:
         for k, v in OrderedDict(sorted(config.items())).items():
-            print('{}: {}'.format(k, v))
+            print(f'{k}: {v}')
     else:
         print('~default configuration~')
 

sphinxcontrib/confluencebuilder/config/__init__.py

@@ -50,9 +50,9 @@ def process_ask_configs(config):
         default_user = config.confluence_server_user
         u_str = ''
         if default_user:
-            u_str = ' [{}]'.format(default_user)
+            u_str = f' [{default_user}]'
 
-        target_user = input(' User{}: '.format(u_str)) or default_user
+        target_user = input(f' User{u_str}: ') or default_user
         if not target_user:
             raise ConfluenceConfigurationError('no user provided')
 

sphinxcontrib/confluencebuilder/config/notifications.py

@@ -45,7 +45,7 @@ def deprecated(validator):
     # inform users of a deprecated configuration being used
     for key, msg in DEPRECATED_CONFIGS.items():
         if config[key] is not None:
-            logger.warn('%s deprecated; %s' % (key, msg))
+            logger.warn(f'{key} deprecated; {msg}')
 
 
 def warnings(validator):

sphinxcontrib/confluencebuilder/config/validation.py

@@ -163,7 +163,7 @@ def docnames(self):
                             os.path.join(self.env.srcdir, docname + suffix))
                         for suffix in self.config.source_suffix):
                     raise ConfluenceConfigurationError(
-                        '%s is missing document %s' % (self.key, docname))
+                        f'{self.key} is missing document {docname}')
 
         return self
 
@@ -198,7 +198,7 @@ def docnames_from_file(self):
                             os.path.join(self.env.srcdir, docname + suffix))
                         for suffix in self.config.source_suffix):
                     raise ConfluenceConfigurationError(
-                        '%s is missing document %s' % (self.key, docname))
+                        f'{self.key} is missing document {docname}')
 
         return self
 

sphinxcontrib/confluencebuilder/intersphinx.py

@@ -36,9 +36,9 @@ def escape(string):
         # header
         f.write((
             '# Sphinx inventory version 2\n'
-            '# Project: %s\n'
-            '# Version: %s\n'
-            '# The remainder of this file is compressed using zlib.\n' % (
+            '# Project: {}\n'
+            '# Version: {}\n'
+            '# The remainder of this file is compressed using zlib.\n'.format(
                 escape(builder.env.config.project),
                 escape(builder.env.config.version))).encode())
 
@@ -53,7 +53,7 @@ def escape(string):
                 if not page_id:
                     continue
 
-                target_name = '{}#{}'.format(docname, raw_anchor)
+                target_name = f'{docname}#{raw_anchor}'
                 target = builder.state.target(target_name)
 
                 if raw_anchor and target:

sphinxcontrib/confluencebuilder/publisher.py

@@ -173,7 +173,7 @@ def archive_page(self, page_id):
             while attempt <= MAX_WAIT_FOR_PAGE_ARCHIVE:
                 time.sleep(0.5)
 
-                rsp = self.rest_client.get('longtask/{}'.format(longtask_id))
+                rsp = self.rest_client.get(f'longtask/{longtask_id}')
                 if rsp['finished']:
                     break
 
@@ -370,7 +370,7 @@ def get_attachment(self, page_id, name):
         attachment = None
         attachment_id = None
 
-        url = 'content/{}/child/attachment'.format(page_id)
+        url = f'content/{page_id}/child/attachment'
         rsp = self.rest_client.get(url, {
             'filename': name,
         })
@@ -397,7 +397,7 @@ def get_attachments(self, page_id):
         """
         attachment_info = {}
 
-        url = 'content/{}/child/attachment'.format(page_id)
+        url = f'content/{page_id}/child/attachment'
         search_fields = {}
 
         # Configure a larger limit value than the default (no provided
@@ -474,7 +474,7 @@ def get_page_by_id(self, page_id, expand='version'):
             the page id and page object
         """
 
-        page = self.rest_client.get('content/{}'.format(page_id), {
+        page = self.rest_client.get(f'content/{page_id}', {
             'status': 'current',
             'expand': expand,
         })
@@ -589,7 +589,7 @@ def store_attachment(self, page_id, name, data, mimetype, hash_, force=False):
         try:
             # split hash comment into chunks to minimize rendering issues with a
             # single one-world-long-hash value
-            hash_ = '{}:{}'.format(HASH_KEY, hash_)
+            hash_ = f'{HASH_KEY}:{hash_}'
             chunked_hash = '\n'.join(
                 [hash_[i:i + 16] for i in range(0, len(hash_), 16)])
 
@@ -603,7 +603,7 @@ def store_attachment(self, page_id, name, data, mimetype, hash_, force=False):
                 data['minorEdit'] = 'true'
 
             if not attachment:
-                url = 'content/{}/child/attachment'.format(page_id)
+                url = f'content/{page_id}/child/attachment'
                 rsp = self.rest_client.post(url, None, files=data)
                 uploaded_attachment_id = rsp['results'][0]['id']
             else:
@@ -711,7 +711,7 @@ def store_page(self, page_name, data, parent_id=None):
                     # initial labels need to be applied in their own request
                     labels = new_page['metadata']['labels']
                     if not self.cloud and labels:
-                        url = 'content/{}/label'.format(uploaded_page_id)
+                        url = f'content/{uploaded_page_id}/label'
                         self.rest_client.post(url, labels)
 
                 except ConfluenceBadApiError as ex:
@@ -1064,7 +1064,7 @@ def _dryrun(self, msg, id_=None, misc=''):
         if id_ and id_ in self._name_cache:
             s += ' ' + self._name_cache[id_]
         if id_:
-            s += ' ({})'.format(id_)
+            s += f' ({id_})'
         if misc:
             s += ' ' + misc
         logger.info(s + min(80, 80 - len(s)) * ' ')  # 80c-min clearing
@@ -1086,7 +1086,7 @@ def _onlynew(self, msg, id_=None):
         if id_ and id_ in self._name_cache:
             s += ' ' + self._name_cache[id_]
         if id_:
-            s += ' ({})'.format(id_)
+            s += f' ({id_})'
         logger.info(s + min(80, 80 - len(s)) * ' ')  # 80c-min clearing
 
     def _populate_labels(self, page, labels):

sphinxcontrib/confluencebuilder/rest.py

@@ -326,12 +326,12 @@ def close(self):
 
     def _format_error(self, rsp, key):
         err = ""
-        err += "REQ: {0}\n".format(rsp.request.method)
+        err += f"REQ: {rsp.request.method}\n"
         err += "RSP: " + str(rsp.status_code) + "\n"
         err += "URL: " + self.url + self.bind_path + "\n"
         err += "API: " + key + "\n"
         try:
-            err += 'DATA: {}'.format(json.dumps(rsp.json(), indent=2))
+            err += f'DATA: {json.dumps(rsp.json(), indent=2)}'
         except:  # noqa: E722
             err += 'DATA: <not-or-invalid-json>'
         return err

sphinxcontrib/confluencebuilder/singlebuilder.py

@@ -33,7 +33,7 @@ def assemble_toc_secnumbers(self):
 
         for docname, secnums in self.env.toc_secnumbers.items():
             for id_, secnum in secnums.items():
-                alias = '{}/{}'.format(docname, id_)
+                alias = f'{docname}/{id_}'
                 new_secnumbers[alias] = secnum
 
         return {self.config.root_doc: new_secnumbers}
@@ -43,7 +43,7 @@ def assemble_toc_fignumbers(self):
 
         for docname, fignumlist in self.env.toc_fignumbers.items():
             for figtype, fignums in fignumlist.items():
-                alias = '{}/{}'.format(docname, figtype)
+                alias = f'{docname}/{figtype}'
                 new_fignumbers.setdefault(alias, {})
 
                 for id_, fignum in fignums.items():
@@ -215,7 +215,7 @@ def _register_doctree_title_targets(self, docname, doctree):
                     for id_ in section_node['ids']:
                         target = title_name
 
-                        anchorname = '%s/#%s' % (docname, id_)
+                        anchorname = f'{docname}/#{id_}'
                         if anchorname not in secnumbers:
                             anchorname = '%s/' % id_
 
@@ -228,7 +228,7 @@ def _register_doctree_title_targets(self, docname, doctree):
                         section_id = doc_used_names.get(target, 0)
                         doc_used_names[target] = section_id + 1
                         if section_id > 0:
-                            target = '{}.{}'.format(target, section_id)
+                            target = f'{target}.{section_id}'
 
                         self.state.register_target(anchorname, target)