Format with ruff

Author: jelmer

contrib/dump_comments.py

@@ -44,21 +44,37 @@
 from textwrap import indent
 
 
-class ColorFallback():
-    __getattr__ = lambda self, name: ''  # noqa: E731
+class ColorFallback:
+    __getattr__ = lambda self, name: ""  # noqa: E731
 
 
 try:
     from colorama import Fore, Style, init
+
     init()  # needed for Windows
 except ImportError:  # fallback so that the imported classes always exist
     Fore = Style = ColorFallback()
 
 
-Comment = namedtuple('Comment', ('uri', 'id', 'parent', 'created', 'text', 'author', 'email', 'website', 'likes', 'dislikes', 'replies'))
+Comment = namedtuple(
+    "Comment",
+    (
+        "uri",
+        "id",
+        "parent",
+        "created",
+        "text",
+        "author",
+        "email",
+        "website",
+        "likes",
+        "dislikes",
+        "replies",
+    ),
+)
 
-INDENT = '    '
-QUERY = 'SELECT uri, comments.id, parent, created, text, author, email, website, likes, dislikes FROM comments INNER JOIN threads on comments.tid = threads.id'
+INDENT = "    "
+QUERY = "SELECT uri, comments.id, parent, created, text, author, email, website, likes, dislikes FROM comments INNER JOIN threads on comments.tid = threads.id"
 
 
 def main():
@@ -78,14 +94,18 @@ def main():
         for comment in comments:
             if comment.parent:  # == this is a "reply" comment
                 comments_per_id[comment.parent].replies.append(comment)
-                if args.sort_by_last_reply and (sort_date is None or comment.created > sort_date):
+                if args.sort_by_last_reply and (
+                    sort_date is None or comment.created > sort_date
+                ):
                     sort_date = comment.created
             else:
                 root_comments.append(comment)
                 if sort_date is None or comment.created > sort_date:
                     sort_date = comment.created
         root_comments_per_sort_date[sort_date] = root_comments
-    for _, root_comments in sorted(root_comments_per_sort_date.items(), key=lambda pair: pair[0]):
+    for _, root_comments in sorted(
+        root_comments_per_sort_date.items(), key=lambda pair: pair[0]
+    ):
         print(Fore.MAGENTA + args.url_prefix + root_comments[0].uri + Fore.RESET)
         for comment in root_comments:
             print_comment(INDENT, comment)
@@ -95,34 +115,55 @@ def main():
 
 
 def print_comment(prefix, comment):
-    author = comment.author or 'Anonymous'
-    email = comment.email or ''
-    website = comment.website or ''
+    author = comment.author or "Anonymous"
+    email = comment.email or ""
+    website = comment.website or ""
     when = date.fromtimestamp(comment.created)
-    popularity = ''
+    popularity = ""
     if comment.likes:
-        popularity = '+{.likes}'.format(comment)
+        popularity = "+{.likes}".format(comment)
     if comment.dislikes:
         if popularity:
-            popularity += '/'
-        popularity = '-{.dislikes}'.format(comment)
-    print(prefix + '{Style.BRIGHT}{author}{Style.RESET_ALL} {Style.DIM}- {email} {website}{Style.RESET_ALL} {when} {Style.DIM}{popularity}{Style.RESET_ALL}'.format(Style=Style, **locals()))
+            popularity += "/"
+        popularity = "-{.dislikes}".format(comment)
+    print(
+        prefix
+        + "{Style.BRIGHT}{author}{Style.RESET_ALL} {Style.DIM}- {email} {website}{Style.RESET_ALL} {when} {Style.DIM}{popularity}{Style.RESET_ALL}".format(
+            Style=Style, **locals()
+        )
+    )
     print(indent(comment.text, prefix))
 
 
 def parse_args():
-    parser = argparse.ArgumentParser(description='Dump all Isso comments in chronological order, grouped by replies',
-                                     formatter_class=ArgparseHelpFormatter)
-    parser.add_argument('db_path', help='File path to Isso Sqlite DB')
-    parser.add_argument('--sort-by-last-reply', action='store_true', help='By default comments are sorted by "parent" comment date, this sort comments based on the last replies')
-    parser.add_argument('--url-prefix', default='', help='Optional domain name to prefix to pages URLs')
-    parser.add_argument('--no-colors', action='store_false', dest='colors', default=True, help='Disabled colored output')
+    parser = argparse.ArgumentParser(
+        description="Dump all Isso comments in chronological order, grouped by replies",
+        formatter_class=ArgparseHelpFormatter,
+    )
+    parser.add_argument("db_path", help="File path to Isso Sqlite DB")
+    parser.add_argument(
+        "--sort-by-last-reply",
+        action="store_true",
+        help='By default comments are sorted by "parent" comment date, this sort comments based on the last replies',
+    )
+    parser.add_argument(
+        "--url-prefix", default="", help="Optional domain name to prefix to pages URLs"
+    )
+    parser.add_argument(
+        "--no-colors",
+        action="store_false",
+        dest="colors",
+        default=True,
+        help="Disabled colored output",
+    )
     return parser.parse_args()
 
 
-class ArgparseHelpFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
+class ArgparseHelpFormatter(
+    argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter
+):
     pass
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

contrib/import_blogger.py

@@ -28,9 +28,12 @@
 try:
     import feedparser
 except ImportError:
-    print("Error: Package feedparser not installed! You can install it via "
-          "'pip install feedparser' inside your virtualenv.")
+    print(
+        "Error: Package feedparser not installed! You can install it via "
+        "'pip install feedparser' inside your virtualenv."
+    )
     import sys
+
     sys.exit(1)
 
 from urllib.parse import urlparse
@@ -43,21 +46,21 @@ def __init__(self, url):
         self.comments = []
 
     def add_comment(self, comment):
-        comment['id'] = len(self.comments) + 1
+        comment["id"] = len(self.comments) + 1
         self.comments.append(comment)
 
 
 def encode_post(post):
     ret = {}
-    ret['id'] = post.url
-    ret['title'] = post.title
-    ret['comments'] = post.comments
+    ret["id"] = post.url
+    ret["title"] = post.title
+    ret["comments"] = post.comments
     return ret
 
 
 class ImportBlogger:
-    TYPE_COMMENT = 'http://schemas.google.com/blogger/2008/kind#comment'
-    TYPE_POST = 'http://schemas.google.com/blogger/2008/kind#post'
+    TYPE_COMMENT = "http://schemas.google.com/blogger/2008/kind#comment"
+    TYPE_POST = "http://schemas.google.com/blogger/2008/kind#post"
 
     def __init__(self, filename_in, filename_out, prefix):
         self.channel = feedparser.parse(filename_in)
@@ -77,7 +80,7 @@ def run(self):
                 self.process_post(item)
 
         data = [encode_post(p) for p in self.posts.values() if p.comments]
-        with open(self.filename_out, 'w') as fp:
+        with open(self.filename_out, "w") as fp:
             json.dump(data, fp, indent=2)
 
     def process_post(self, item):
@@ -99,29 +102,33 @@ def ensure_post(self, item):
 
     def process_comment(self, item):
         comment = {}
-        comment['author'] = item.author_detail.name
-        comment['email'] = item.author_detail.email
-        comment['website'] = item.author_detail.get('href', '')
-        t = time.strftime('%Y-%m-%d %H:%M:%S', item.published_parsed)
-        comment['created'] = t
-        comment['text'] = item.content[0].value
-        comment['remote_addr'] = '127.0.0.1'
+        comment["author"] = item.author_detail.name
+        comment["email"] = item.author_detail.email
+        comment["website"] = item.author_detail.get("href", "")
+        t = time.strftime("%Y-%m-%d %H:%M:%S", item.published_parsed)
+        comment["created"] = t
+        comment["text"] = item.content[0].value
+        comment["remote_addr"] = "127.0.0.1"
         return comment
 
     def post_id(self, item):
         u = urlparse(item.link)
         return self.prefix + u.path
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     import argparse
-    parser = argparse.ArgumentParser(
-        description='Convert comments from blogger.com')
-    parser.add_argument('input', help='input file')
-    parser.add_argument('output', help='output file')
-    parser.add_argument('-p', dest='prefix',
-                        help='prefix to be added to paths (ID)',
-                        type=str, default='')
+
+    parser = argparse.ArgumentParser(description="Convert comments from blogger.com")
+    parser.add_argument("input", help="input file")
+    parser.add_argument("output", help="output file")
+    parser.add_argument(
+        "-p",
+        dest="prefix",
+        help="prefix to be added to paths (ID)",
+        type=str,
+        default="",
+    )
     args = parser.parse_args()
 
     importer = ImportBlogger(args.input, args.output, args.prefix)

docs/_extensions/sphinx_reredirects/__init__.py

@@ -19,7 +19,9 @@
 OPTION_TEMPLATE_FILE = "redirect_html_template_file"
 OPTION_TEMPLATE_FILE_DEFAULT = None
 
-REDIRECT_FILE_DEFAULT_TEMPLATE = '<html><head><meta http-equiv="refresh" content="0; url=${to_uri}"></head></html>'  # noqa: E501
+REDIRECT_FILE_DEFAULT_TEMPLATE = (
+    '<html><head><meta http-equiv="refresh" content="0; url=${to_uri}"></head></html>'  # noqa: E501
+)
 
 logger = logging.getLogger(__name__)
 
@@ -32,13 +34,12 @@ def setup(app: Sphinx):
     """
     app.connect("html-collect-pages", init)
     app.add_config_value(OPTION_REDIRECTS, OPTION_REDIRECTS_DEFAULT, "env")
-    app.add_config_value(OPTION_TEMPLATE_FILE, OPTION_TEMPLATE_FILE_DEFAULT,
-                         "env")
+    app.add_config_value(OPTION_TEMPLATE_FILE, OPTION_TEMPLATE_FILE_DEFAULT, "env")
 
 
 def init(app: Sphinx):
     if not app.config[OPTION_REDIRECTS]:
-        logger.debug('No redirects configured')
+        logger.debug("No redirects configured")
         return
 
     rr = Reredirects(app)
@@ -53,11 +54,8 @@ def init(app: Sphinx):
 class Reredirects:
     def __init__(self, app: Sphinx):
         self.app = app
-        self.redirects_option: Dict[str,
-                                    str] = getattr(app.config,
-                                                   OPTION_REDIRECTS)
-        self.template_file_option: str = getattr(app.config,
-                                                 OPTION_TEMPLATE_FILE)
+        self.redirects_option: Dict[str, str] = getattr(app.config, OPTION_REDIRECTS)
+        self.template_file_option: str = getattr(app.config, OPTION_TEMPLATE_FILE)
 
     def grab_redirects(self) -> Mapping[str, str]:
         """Inspect redirects option in conf.py and returns dict mapping \
@@ -91,17 +89,20 @@ def create_redirects(self, to_be_redirected: Mapping[str, str]):
         """Create actual redirect file for each pair in passed mapping of \
         docnames to targets."""
         for doc, target in to_be_redirected.items():
-            redirect_file_abs = Path(
-                self.app.outdir).joinpath(doc, "index.html")
+            redirect_file_abs = Path(self.app.outdir).joinpath(doc, "index.html")
             redirect_file_rel = redirect_file_abs.relative_to(self.app.outdir)
 
             if redirect_file_abs.exists():
-                logger.info(f"Creating redirect file '{redirect_file_rel}' "
-                            f"pointing to '{target}' that replaces "
-                            f"document '{doc}'.")
+                logger.info(
+                    f"Creating redirect file '{redirect_file_rel}' "
+                    f"pointing to '{target}' that replaces "
+                    f"document '{doc}'."
+                )
             else:
-                logger.info(f"Creating redirect file '{redirect_file_rel}' "
-                            f"pointing to '{target}'.")
+                logger.info(
+                    f"Creating redirect file '{redirect_file_rel}' "
+                    f"pointing to '{target}'."
+                )
 
             self._create_redirect_file(redirect_file_abs, target)
 
@@ -129,8 +130,7 @@ def _render_redirect_template(self, to_uri) -> str:
         # HTML used as redirect file content
         redirect_template = REDIRECT_FILE_DEFAULT_TEMPLATE
         if self.template_file_option:
-            redirect_file_abs = Path(self.app.srcdir,
-                                     self.template_file_option)
+            redirect_file_abs = Path(self.app.srcdir, self.template_file_option)
             redirect_template = redirect_file_abs.read_text()
 
         content = Template(redirect_template).substitute({"to_uri": to_uri})

docs/_theme/remove_heading.py

@@ -1,10 +1,8 @@
-
 from docutils import nodes
 from sphinx.writers.html import HTMLTranslator
 
 
 class IssoTranslator(HTMLTranslator):
-
     def visit_title(self, node):
         if self.section_level == 1:
             raise nodes.SkipNode