Merge pull request #760 from sphinx-contrib/code-cleanup

code cleanup to use python 3 capabilities

Author: jdknight

sphinxcontrib/confluencebuilder/assets.py

@@ -84,7 +84,7 @@ def add(self, path, docname):
         """
         logger.verbose('adding manual attachment: %s' % path)
         abspath = find_env_abspath(self.env, self.outdir, path)
-        return self._handle_entry(abspath, docname, True)
+        return self._handle_entry(abspath, docname, standalone=True)
 
     def build(self):
         """
@@ -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

@@ -38,7 +38,6 @@
 from sphinxcontrib.confluencebuilder.util import first
 from sphinxcontrib.confluencebuilder.util import handle_cli_file_subset
 from sphinxcontrib.confluencebuilder.writer import ConfluenceWriter
-import io
 import os
 import tempfile
 
@@ -57,10 +56,10 @@ def __init__(self, app, env=None):
         # assigned.
         if sphinx_version_info >= (5, 1):
             # pylint: disable=too-many-function-args
-            super(ConfluenceBuilder, self).__init__(app, env)
+            super().__init__(app, env)
             # pylint: enable=too-many-function-args
         else:
-            super(ConfluenceBuilder, self).__init__(app)
+            super().__init__(app)
 
         self.cache_doctrees = {}
         self.cloud = False
@@ -252,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:
@@ -477,11 +476,11 @@ def write_doc(self, docname, doctree):
         if self.writer.output is not None:
             ensuredir(path.dirname(outfilename))
             try:
-                with io.open(outfilename, 'w', encoding='utf-8') as file:
+                with open(outfilename, 'w', encoding='utf-8') as file:
                     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
@@ -698,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,
@@ -733,12 +732,12 @@ def finish(self):
                 docfile = path.join(self.outdir, self.file_transform(docname))
 
                 try:
-                    with io.open(docfile, 'r', encoding='utf-8') as file:
+                    with open(docfile, 'r', encoding='utf-8') as file:
                         output = file.read()
                         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)
@@ -769,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()
@@ -864,10 +863,10 @@ def _generate_special_document(self, docname, generator):
                 fname = path.join(self.env.srcdir,
                     self.config.confluence_header_file)
                 try:
-                    with io.open(fname, encoding='utf-8') as file:
+                    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:
@@ -886,10 +885,10 @@ def _generate_special_document(self, docname, generator):
                 fname = path.join(self.env.srcdir,
                     self.config.confluence_footer_file)
                 try:
-                    with io.open(fname, encoding='utf-8') as file:
+                    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:
@@ -902,7 +901,7 @@ def _generate_special_document(self, docname, generator):
         # generate/replace the document in the output directory
         fname = path.join(self.outdir, docname + self.file_suffix)
         try:
-            with io.open(fname, 'w', encoding='utf-8') as f:
+            with open(fname, 'w', encoding='utf-8') as f:
                 f.write(self._cached_header_data)
                 generator(self, docname, f)
                 f.write(self._cached_footer_data)
@@ -973,7 +972,7 @@ def _header_footer_init(self, docname, doctree):
                 else:
                     # unsupported source type should not pass here after this
                     # extension's configuration check
-                    assert False
+                    raise AssertionError('unsupported source type')
 
                 sourcelink['url'] = url_base + url
 
@@ -1085,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):
@@ -1121,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/build.py

@@ -1,6 +1,7 @@
 # SPDX-License-Identifier: BSD-2-Clause
 # Copyright 2020-2023 Sphinx Confluence Builder Contributors (AUTHORS)
 
+from contextlib import suppress
 from sphinx.application import Sphinx
 from sphinx.util.docutils import docutils_namespace
 from sphinxcontrib.confluencebuilder.logger import ConfluenceLogger as logger
@@ -51,10 +52,8 @@ def build_main(args_parser):
 
     verbosity = 0
     if args.verbose:
-        try:
+        with suppress(ValueError):
             verbosity = int(args.verbose)
-        except ValueError:
-            pass
 
     # run sphinx engine
     with docutils_namespace():

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/exceptions.py

@@ -11,7 +11,7 @@ class ConfluenceError(SphinxError):
 
 class ConfluenceAuthenticationFailedUrlError(ConfluenceError):
     def __init__(self):
-        super(ConfluenceAuthenticationFailedUrlError, self).__init__('''
+        super().__init__('''
 ---
 Unable to authenticate with Confluence
 
@@ -25,7 +25,7 @@ def __init__(self):
 
 class ConfluenceBadApiError(ConfluenceError):
     def __init__(self, code, details):
-        super(ConfluenceBadApiError, self).__init__('''
+        super().__init__('''
 ---
 Unsupported Confluence API call
 
@@ -43,7 +43,7 @@ def __init__(self, space_key, uname, pw_set, token_set, extras):
         uname_value = uname if uname else '(empty)'
         pw_value = '<set>' if pw_set else '(empty)'
         token_value = '<set>' if token_set else '(empty)'
-        super(ConfluenceBadSpaceError, self).__init__('''
+        super().__init__('''
 ---
 Invalid Confluence URL detected
 
@@ -66,7 +66,7 @@ def __init__(self, space_key, uname, pw_set, token_set, extras):
 
 class ConfluenceBadServerUrlError(ConfluenceError):
     def __init__(self, server_url, ex):
-        super(ConfluenceBadServerUrlError, self).__init__('''
+        super().__init__('''
 ---
 Invalid Confluence URL detected
 
@@ -83,7 +83,7 @@ def __init__(self, server_url, ex):
 
 class ConfluenceCertificateError(ConfluenceError):
     def __init__(self, ex):
-        super(ConfluenceCertificateError, self).__init__('''
+        super().__init__('''
 ---
 SSL certificate issue
 
@@ -101,7 +101,7 @@ class ConfluenceConfigurationError(ConfluenceError, ConfigError):
 
 class ConfluenceMissingPageIdError(ConfluenceError):
     def __init__(self, space_key, page_id):
-        super(ConfluenceMissingPageIdError, self).__init__('''
+        super().__init__('''
 ---
 Unable to find a requested page
 
@@ -117,7 +117,7 @@ def __init__(self, space_key, page_id):
 
 class ConfluencePermissionError(ConfluenceError):
     def __init__(self, details):
-        super(ConfluencePermissionError, self).__init__('''
+        super().__init__('''
 ---
 Permission denied on Confluence ({desc})
 
@@ -130,7 +130,7 @@ def __init__(self, details):
 
 class ConfluenceProxyPermissionError(ConfluenceError):
     def __init__(self):
-        super(ConfluenceProxyPermissionError, self).__init__('''
+        super().__init__('''
 ---
 Unable to authenticate with the proxy server
 
@@ -148,7 +148,7 @@ class ConfluencePublishCheckError(ConfluenceError):
 
 class ConfluencePublishAncestorError(ConfluencePublishCheckError):
     def __init__(self, page_name):
-        super(ConfluencePublishAncestorError, self).__init__('''
+        super().__init__('''
 ---
 Ancestor publish check failed for: {name}
 
@@ -177,7 +177,7 @@ def __init__(self, page_name):
 
 class ConfluencePublishSelfAncestorError(ConfluencePublishCheckError):
     def __init__(self, page_name):
-        super(ConfluencePublishSelfAncestorError, self).__init__('''
+        super().__init__('''
 ---
 Ancestor (self) publish check failed for: {name}
 
@@ -198,7 +198,7 @@ def __init__(self, page_name):
 
 class ConfluenceRateLimited(ConfluenceError):
     def __init__(self):
-        super(ConfluenceRateLimited, self).__init__('''
+        super().__init__('''
 ---
 Request has been rate limited
 
@@ -211,7 +211,7 @@ def __init__(self):
 
 class ConfluenceSeraphAuthenticationFailedUrlError(ConfluenceError):
     def __init__(self):
-        super(ConfluenceSeraphAuthenticationFailedUrlError, self).__init__('''
+        super().__init__('''
 ---
 Unable to authenticate with the Confluence instance (Seraph)
 
@@ -226,7 +226,7 @@ def __init__(self):
 
 class ConfluenceSslError(ConfluenceError):
     def __init__(self, server_url, ex):
-        super(ConfluenceSslError, self).__init__('''
+        super().__init__('''
 ---
 SSL connection issue has been detected
 
@@ -249,7 +249,7 @@ def __init__(self, server_url, ex):
 
 class ConfluenceTimeoutError(ConfluenceError):
     def __init__(self, server_url):
-        super(ConfluenceTimeoutError, self).__init__('''
+        super().__init__('''
 ---
 Connection has timed out
 
@@ -265,7 +265,7 @@ def __init__(self, server_url):
 
 class ConfluenceUnreconciledPageError(ConfluenceError):
     def __init__(self, page_name, page_id, url, ex):
-        super(ConfluenceUnreconciledPageError, self).__init__('''
+        super().__init__('''
 ---
 Unable to update unreconciled page: {name} (id: {id})