Apply Black with string normalization.

Author: rht

archive.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-'''
+"""
 This is the main program for the Zulip archive system.  For help:
 
     python archive.py -h
@@ -15,7 +15,7 @@
 
     lib/html.py
     lib/populate.py
-'''
+"""
 
 
 # The workflow (timing for the leanprover Zulip chat, on my slow laptop):
@@ -54,25 +54,25 @@
 except ModuleNotFoundError:
     # TODO: Add better instructions.
     exit_immediately(
-        '''
+        """
     We can't find settings.py.
 
     Please copy default_settings.py to settings.py
     and then edit the settings.py file to fit your use case.
 
     For testing, you can often leave the default settings,
     but you will still want to review them first.
-    '''
+    """
     )
 
-NO_JSON_DIR_ERROR_WRITE = '''
+NO_JSON_DIR_ERROR_WRITE = """
 We cannot find a place to write JSON files.
 
 Please run the below command:
 
-mkdir {}'''
+mkdir {}"""
 
-NO_JSON_DIR_ERROR_READ = '''
+NO_JSON_DIR_ERROR_READ = """
 We cannot find a place to read JSON files.
 
 Please run the below command:
@@ -81,14 +81,14 @@
 
 And then fetch the JSON:
 
-python archive.py -t'''
+python archive.py -t"""
 
-NO_HTML_DIR_ERROR = '''
+NO_HTML_DIR_ERROR = """
 We cannot find a place to write HTML files.
 
 Please run the below command:
 
-mkdir {}'''
+mkdir {}"""
 
 
 def get_json_directory(for_writing):
@@ -105,7 +105,7 @@ def get_json_directory(for_writing):
         exit_immediately(error_msg)
 
     if not json_dir.is_dir():
-        exit_immediately(str(json_dir) + ' needs to be a directory')
+        exit_immediately(str(json_dir) + " needs to be a directory")
 
     return settings.json_directory
 
@@ -119,50 +119,50 @@ def get_html_directory():
         exit_immediately(error_msg)
 
     if not html_dir.is_dir():
-        exit_immediately(str(html_dir) + ' needs to be a directory')
+        exit_immediately(str(html_dir) + " needs to be a directory")
 
     return settings.html_directory
 
 
 def get_client_info():
-    config_file = './zuliprc'
+    config_file = "./zuliprc"
     client = zulip.Client(config_file=config_file)
 
     # It would be convenient if the Zulip client object
     # had a `site` field, but instead I just re-read the file
     # directly to get it.
     config = configparser.RawConfigParser()
     config.read(config_file)
-    zulip_url = config.get('api', 'site')
+    zulip_url = config.get("api", "site")
 
     return client, zulip_url
 
 
 def run():
     parser = argparse.ArgumentParser(
-        description='Build an html archive of the Zulip chat.'
+        description="Build an html archive of the Zulip chat."
     )
     parser.add_argument(
-        '-b', action='store_true', default=False, help='Build .md files'
+        "-b", action="store_true", default=False, help="Build .md files"
     )
     parser.add_argument(
-        '-t', action='store_true', default=False, help='Make a clean json archive'
+        "-t", action="store_true", default=False, help="Make a clean json archive"
     )
     parser.add_argument(
-        '-i',
-        action='store_true',
+        "-i",
+        action="store_true",
         default=False,
-        help='Incrementally update the json archive',
+        help="Incrementally update the json archive",
     )
 
     results = parser.parse_args()
 
     if results.t and results.i:
-        print('Cannot perform both a total and incremental update. Use -t or -i.')
+        print("Cannot perform both a total and incremental update. Use -t or -i.")
         exit(1)
 
     if not (results.t or results.i or results.b):
-        print('\nERROR!\n\nYou have not specified any work to do.\n')
+        print("\nERROR!\n\nYou have not specified any work to do.\n")
         parser.print_help()
         exit(1)
 
@@ -208,5 +208,5 @@ def run():
         )
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     run()

default_settings.py

@@ -12,56 +12,56 @@
 import yaml
 from pathlib import Path
 
-'''
+"""
 You generally want to start in debug mode to test out the archive,
 and then set PROD_ARCHIVE to turn on production settings here.  In
 production you usually change two things--the site_url and your
 html_directory.
-'''
+"""
 
-if os.getenv('PROD_ARCHIVE'):
+if os.getenv("PROD_ARCHIVE"):
     DEBUG = False
 else:
     DEBUG = True
 
-'''
+"""
 Set the site url.  The default below is good for local testing, but you will
 definitely need to set your own value for prod.
-'''
+"""
 
 if DEBUG:
-    site_url = 'http://127.0.0.1:4000'
+    site_url = "http://127.0.0.1:4000"
 else:
-    site_url = os.getenv('SITE_URL')
+    site_url = os.getenv("SITE_URL")
     if not site_url:
         raise Exception("You need to configure site_url for prod")
 
-'''
+"""
 Set the zulip icon url.  Folks can press the icon to see a
 message in the actual Zulip instance.
-'''
+"""
 
 if DEBUG:
-    zulip_icon_url = 'http://127.0.0.1:4000/assets/img/zulip.svg'
+    zulip_icon_url = "http://127.0.0.1:4000/assets/img/zulip.svg"
 else:
     # Set this according to how you serve your prod assets.
     zulip_icon_url = os.getenv("ZULIP_ICON_URL", None)
 
 
-'''
+"""
 Set the HTML title of your Zulip archive here.
-'''
-title = 'Zulip Chat Archive'  # Modify me!
+"""
+title = "Zulip Chat Archive"  # Modify me!
 
-'''
+"""
 Set the path prefix of your URLs for your website.
 
 For example, you might want your main page to have
 the path of archive/index.html
-'''
+"""
 html_root = os.getenv("HTML_ROOT", "archive")  # Modify me!
 
-'''
+"""
 When we get content from your Zulip instance, we first create
 JSON files that include all of the content data from the Zulip
 instance.  Having the data in JSON makes it easy to incrementally
@@ -70,43 +70,43 @@
 You will want to put this in a permanent location outside of
 your repo.  Here we assume a sibling directory named zulip_json, but
 you may prefer another directory structure.
-'''
+"""
 
 json_directory = Path(os.getenv("JSON_DIRECTORY", "../zulip_json"))
 
-'''
+"""
 We write HTML to here.
-'''
+"""
 if DEBUG:
-    html_directory = Path('./archive')  # Modify me!
+    html_directory = Path("./archive")  # Modify me!
 else:
     try:
         html_directory = Path(os.getenv("HTML_DIRECTORY", None))
     except TypeError:
         raise Exception(
-            '''
+            """
             You need to set html_directory for prod, and it
             should be a different location than DEBUG mode,
             since files will likely have different urls in
             anchor tags.
-            '''
+            """
         )
 
 
-'''
+"""
 This is where you modify the <head> section of every page.
-'''
+"""
 page_head_html = (
     '<html>\n<head><meta charset="utf-8"><title>Zulip Chat Archive</title></head>\n'
 )
 
-'''
+"""
 This is where you modify the <footer> section of every page.
-'''
-page_footer_html = '\n</html>'
+"""
+page_footer_html = "\n</html>"
 
 
-'''
+"""
 You may only want to include certain streams.  In `streams.yaml`
 file, mention the streams you want to include under `included` section.
 
@@ -141,7 +141,7 @@
   - checkins
   - development help
 
-'''
+"""
 
 try:
     with open("streams.yaml") as f:

github.py

@@ -13,43 +13,43 @@
 from datetime import datetime
 import time, argparse, subprocess
 
-parser = argparse.ArgumentParser(description='Push/pull repo.')
+parser = argparse.ArgumentParser(description="Push/pull repo.")
 
 # resets the current repository to match origin/master
 def github_pull():
-    print(subprocess.check_output(['git', 'fetch', 'origin', 'master']))
-    print(subprocess.check_output(['git', 'reset', '--hard', 'origin/master']))
+    print(subprocess.check_output(["git", "fetch", "origin", "master"]))
+    print(subprocess.check_output(["git", "reset", "--hard", "origin/master"]))
 
 
 # commits changes in archive/ and pushes the current repository to origin/master
 def github_push():
-    print(subprocess.check_output(['git', 'add', 'archive/*']))
-    print(subprocess.check_output(['git', 'add', '_includes/archive_update.html']))
+    print(subprocess.check_output(["git", "add", "archive/*"]))
+    print(subprocess.check_output(["git", "add", "_includes/archive_update.html"]))
     print(
         subprocess.check_output(
             [
-                'git',
-                'commit',
-                '-m',
-                'auto update: {}'.format(
+                "git",
+                "commit",
+                "-m",
+                "auto update: {}".format(
                     datetime.utcfromtimestamp(time.time()).strftime(
-                        '%b %d %Y at %H:%M UTC'
+                        "%b %d %Y at %H:%M UTC"
                     )
                 ),
             ]
         )
     )
-    print(subprocess.check_output(['git', 'push']))
+    print(subprocess.check_output(["git", "push"]))
 
 
 parser.add_argument(
-    '-f',
-    action='store_true',
+    "-f",
+    action="store_true",
     default=False,
-    help='Pull from GitHub before updating. (Warning: could overwrite this script.)',
+    help="Pull from GitHub before updating. (Warning: could overwrite this script.)",
 )
 parser.add_argument(
-    '-p', action='store_true', default=False, help='Push results to GitHub.'
+    "-p", action="store_true", default=False, help="Push results to GitHub."
 )
 
 if results.f:

lib/common.py

@@ -2,25 +2,25 @@
 
 
 def exit_immediately(s):
-    print('\nERROR\n', s)
+    print("\nERROR\n", s)
     exit(1)
 
 
 # Safely open dir/filename, creating dir if it doesn't exist
 def open_outfile(dir, filename, mode):
     if not dir.exists():
         os.makedirs(str(dir))
-    return (dir / filename).open(mode, encoding='utf-8')
+    return (dir / filename).open(mode, encoding="utf-8")
 
 
 def stream_validator(settings):
-    if not hasattr(settings, 'included_streams'):
-        exit_immediately('Please set included_streams.')
+    if not hasattr(settings, "included_streams"):
+        exit_immediately("Please set included_streams.")
 
     if len(settings.included_streams) == 0:
         exit_immediately('Please add "*" to included_streams.')
 
-    if hasattr(settings, 'excluded_streams'):
+    if hasattr(settings, "excluded_streams"):
         excluded_streams = set(settings.excluded_streams)
     else:
         excluded_streams = set()
@@ -31,7 +31,7 @@ def validator(stream):
         if stream in excluded_streams:
             return False
 
-        if '*' in included_streams:
+        if "*" in included_streams:
             return True
 
         return stream in included_streams

lib/date_helper.py

@@ -3,5 +3,5 @@
 # I don't love this format, feel free to change (I just
 # extracted it from prior code).
 def format_date1(ts):
-    ''' Nov 05 2019 at 02:51'''
-    return datetime.utcfromtimestamp(ts).strftime('%b %d %Y at %H:%M')
+    """ Nov 05 2019 at 02:51"""
+    return datetime.utcfromtimestamp(ts).strftime("%b %d %Y at %H:%M")