Merge pull request #1084 from isso-comments/ruff

Format with ruff

Author: jelmer

.github/workflows/python-tests.yml

@@ -72,11 +72,14 @@ jobs:
       run: pip install pytest pytest-cov
 
     - name: Install style check dependencies
-      run: pip install flake8
+      run: pip install ruff
 
     - name: Run style check
       run: make flakes
 
+    - name: Run format check
+      run: make format-check
+
     - name: Run coverage check, fail if <70%
       run: |
         make coverage

Dockerfile

@@ -53,7 +53,7 @@ RUN virtualenv --download /isso \
 # Install Isso's python dependencies via pip in a separate step before copying
 # over client files, so that changing Isso js/python source code will not
 # trigger a re-installation of all pip packages from scratch
-COPY ["setup.py", "setup.cfg", "README.md", "LICENSE", "./"]
+COPY ["setup.py", "pyproject.toml", "README.md", "LICENSE", "./"]
 RUN --mount=type=cache,target=/root/.cache \
   . /isso/bin/activate \
  && pip install -e .

Makefile

@@ -49,7 +49,13 @@ init:
 	npm install --omit=optional
 
 flakes:
-	flake8 isso/ contrib/ --count --max-line-length=127 --show-source --statistics
+	ruff check isso/ contrib/ --statistics
+
+format:
+	ruff format isso/ contrib/
+
+format-check:
+	ruff format --check isso/ contrib/
 
 # Note: It doesn't make sense to split up configs by output file with
 # webpack, just run everything at once

contrib/dump_comments.py

@@ -44,21 +44,24 @@
 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():
@@ -95,34 +98,44 @@ 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):
     pass
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

contrib/import_blogger.py

@@ -28,9 +28,9 @@
 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 +43,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 +77,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 +99,27 @@ 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)