Apply Black but skip string normalization.

Author: rht

archive.py

@@ -28,45 +28,42 @@
 #
 
 import sys
-if sys.version_info < (3,6):
+
+if sys.version_info < (3, 6):
     version_error = " Python version must be 3.6 or higher\n\
             Your current version of python is {}.{}\n\
-            Please try again with python3.".format(sys.version_info.major,sys.version_info.minor)
+            Please try again with python3.".format(
+        sys.version_info.major, sys.version_info.minor
+    )
     raise Exception(version_error)
 import argparse
 import configparser
 import os
 import zulip
 
-from lib.common import (
-    stream_validator,
-    exit_immediately
-    )
+from lib.common import stream_validator, exit_immediately
 
 # Most of the heavy lifting is done by the following modules:
 
-from lib.populate import (
-    populate_all,
-    populate_incremental
-    )
+from lib.populate import populate_all, populate_incremental
 
-from lib.website import (
-    build_website
-    )
+from lib.website import build_website
 
 try:
     import settings
 except ModuleNotFoundError:
     # TODO: Add better instructions.
-    exit_immediately('''
+    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 = '''
 We cannot find a place to write JSON files.
@@ -93,6 +90,7 @@
 
 mkdir {}'''
 
+
 def get_json_directory(for_writing):
     json_dir = settings.json_directory
 
@@ -111,6 +109,7 @@ def get_json_directory(for_writing):
 
     return settings.json_directory
 
+
 def get_html_directory():
     html_dir = settings.html_directory
 
@@ -124,6 +123,7 @@ def get_html_directory():
 
     return settings.html_directory
 
+
 def get_client_info():
     config_file = './zuliprc'
     client = zulip.Client(config_file=config_file)
@@ -137,11 +137,23 @@ def get_client_info():
 
     return client, zulip_url
 
+
 def run():
-    parser = argparse.ArgumentParser(description='Build an html archive of the Zulip chat.')
-    parser.add_argument('-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')
-    parser.add_argument('-i', action='store_true', default=False, help='Incrementally update the json archive')
+    parser = argparse.ArgumentParser(
+        description='Build an html archive of the Zulip chat.'
+    )
+    parser.add_argument(
+        '-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'
+    )
+    parser.add_argument(
+        '-i',
+        action='store_true',
+        default=False,
+        help='Incrementally update the json archive',
+    )
 
     results = parser.parse_args()
 
@@ -172,14 +184,14 @@ def run():
             client,
             json_root,
             is_valid_stream_name,
-            )
+        )
 
     elif results.i:
         populate_incremental(
             client,
             json_root,
             is_valid_stream_name,
-            )
+        )
 
     if results.b:
         build_website(
@@ -193,7 +205,8 @@ def run():
             repo_root,
             settings.page_head_html,
             settings.page_footer_html,
-            )
+        )
+
 
 if __name__ == '__main__':
     run()

default_settings.py

@@ -83,18 +83,22 @@
     try:
         html_directory = Path(os.getenv("HTML_DIRECTORY", None))
     except TypeError:
-        raise Exception('''
+        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'
+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.
@@ -143,7 +147,9 @@
     with open("streams.yaml") as f:
         streams = yaml.load(f, Loader=yaml.BaseLoader)
         if "included" not in streams or not streams["included"]:
-            raise Exception("Please specify the streams to be included under `included` section in streams.yaml file")
+            raise Exception(
+                "Please specify the streams to be included under `included` section in streams.yaml file"
+            )
         included_streams = streams["included"]
 
         excluded_streams = []

github.py

@@ -17,18 +17,40 @@
 
 # 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','commit','-m','auto update: {}'.format(datetime.utcfromtimestamp(time.time()).strftime('%b %d %Y at %H:%M UTC'))]))
-    print(subprocess.check_output(['git','push']))
-
-parser.add_argument('-f', action='store_true', default=False, 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.')
+    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(
+                    datetime.utcfromtimestamp(time.time()).strftime(
+                        '%b %d %Y at %H:%M UTC'
+                    )
+                ),
+            ]
+        )
+    )
+    print(subprocess.check_output(['git', 'push']))
+
+
+parser.add_argument(
+    '-f',
+    action='store_true',
+    default=False,
+    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.'
+)
 
 if results.f:
     github_pull()

lib/common.py

@@ -1,15 +1,18 @@
 import os
 
+
 def exit_immediately(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')
 
+
 def stream_validator(settings):
     if not hasattr(settings, 'included_streams'):
         exit_immediately('Please set included_streams.')

lib/files.py

@@ -62,47 +62,51 @@
 
 from .common import open_outfile
 
+
 def read_zulip_stream_info(json_root):
-    '''
+    """
     stream_index.json
 
     This JSON goes two levels deep, showing every stream, and
     then within each stream, a bit of info for every topic in
     the stream.  To get actual messages within a topic, you go
     to other files deeper in the directory structure.
-    '''
+    """
     f = (json_root / Path('stream_index.json')).open('r', encoding='utf-8')
     stream_info = json.load(f, encoding='utf-8')
     f.close()
     return stream_info
 
+
 def read_zulip_messages_for_topic(
-        json_root,
-        sanitized_stream_name,
-        sanitized_topic_name
-        ):
-    '''
+    json_root, sanitized_stream_name, sanitized_topic_name
+):
+    """
     <stream>/<topic>.json
 
     This JSON has info for all the messags in a topic.
-    '''
-    json_path = json_root / Path(sanitized_stream_name) / Path (sanitized_topic_name + '.json')
+    """
+    json_path = (
+        json_root / Path(sanitized_stream_name) / Path(sanitized_topic_name + '.json')
+    )
     f = json_path.open('r', encoding='utf-8')
     messages = json.load(f)
     f.close()
     return messages
 
+
 def open_main_page(md_root):
     outfile = open_outfile(md_root, Path('index.html'), 'w+')
     return outfile
 
+
 def open_stream_topics_page(md_root, sanitized_stream_name):
-    directory = md_root / Path('stream/'+sanitized_stream_name)
+    directory = md_root / Path('stream/' + sanitized_stream_name)
     outfile = open_outfile(directory, Path('index.html'), 'w+')
     return outfile
 
+
 def open_topic_messages_page(md_root, sanitized_stream_name, sanitized_topic_name):
-    directory = md_root / Path('stream/'+sanitized_stream_name+'/topic')
+    directory = md_root / Path('stream/' + sanitized_stream_name + '/topic')
     outfile = open_outfile(directory, Path(sanitized_topic_name + '.html'), 'w+')
     return outfile
-