moving more stuff to common.py

Author: Akuli

common.py

@@ -26,9 +26,15 @@
 
 # For more information, please refer to <http://unlicense.org>
 
-"""Things that other scripts import and use."""
+"""Things that other scripts import and use.
+
+The markdown files use / as a path separator. That's why they need the
+posixpath module for processing paths, but they use functions in this
+file when actually opening files.
+"""
 
 import itertools
+import os
 import re
 
 
@@ -93,3 +99,13 @@ def askyesno(question, default=True):
             return False
         if not result:
             return default
+
+
+def slashfix(path):
+    """Replace / with os.sep."""
+    return path.replace('/', os.sep)
+
+
+def slashfix_open(file, mode):
+    """An easy way to use slashfix() and open() together."""
+    return open(slashfix(file), mode)

linkcheck.py

@@ -110,7 +110,7 @@ def main():
     print("Searching links...")
     links = []
     for path in common.get_markdown_files():
-        with open(path.replace('/', os.sep), 'r') as f:
+        with common.slashfix_open(path, 'r') as f:
             for match, lineno in common.find_links(f):
                 links.append(Link(match, path, lineno))
     print("  found", len(links), "links")

make-html.py

@@ -67,8 +67,9 @@
 """
 
 
-def mkdir_open(filename, mode):
-    """Like open(), but make directories as needed."""
+def mkdir_slashfix_open(filename, mode):
+    """Like common.slashfix_open(), but make directories as needed."""
+    filename = common.slashfix(filename)
     directory = os.path.dirname(filename)
     os.makedirs(directory, exist_ok=True)
     return open(filename, mode)
@@ -198,12 +199,12 @@ def main():
     for markdownfile in common.get_markdown_files():
         htmlfile = os.path.join('html', fix_filename(markdownfile))
         print(' ', markdownfile, '->', htmlfile)
-        with open(markdownfile.replace('/', os.sep), 'r') as f:
+        with common.slashfix_open(markdownfile, 'r') as f:
             markdown = f.read()
         renderer = TutorialRenderer()
         body = mistune.markdown(markdown, renderer=renderer)
         html = HTML_TEMPLATE.format(title=renderer.title, body=body)
-        with mkdir_open(htmlfile.replace('/', os.sep), 'w') as f:
+        with mkdir_slashfix_open(htmlfile, 'w') as f:
             print(html, file=f)
 
     print("Copying other files...")

strip.py

@@ -28,13 +28,11 @@
 
 """Strip trailing whitespace from markdown files."""
 
-import os
-
 import common
 
 
-def needs_stripping(realfile):
-    with open(realfile, 'r') as f:
+def needs_stripping(file):
+    with common.slashfix_open(file, 'r') as f:
         for line in f:
             line = line.rstrip('\n')
             if line != line.rstrip():
@@ -43,23 +41,22 @@ def needs_stripping(realfile):
     return False
 
 
-def strip(realfile):
+def strip(file):
     lines = []
-    with open(realfile, 'r') as f:
+    with common.slashfix_open(file, 'r') as f:
         for line in f:
             lines.append(line.rstrip())
-    with open(realfile, 'w') as f:
+    with common.slashfix_open(file, 'w') as f:
         for line in lines:
             print(line, file=f)
 
 
 def main():
     print("Stripping trailing whitespace...")
     for file in common.get_markdown_files():
-        realfile = file.replace('/', os.sep)
-        if needs_stripping(realfile):
-            strip(realfile)
-            print("  Was stripped:", file)
+        if needs_stripping(file):
+            print("  Stripping:", file)
+            strip(file)
         else:
             print("  No trailing whitespace:", file)
 

update-ends.py

@@ -28,10 +28,6 @@
 
 """Update ends of markdown files."""
 
-# Markdown and HTML links use / as a path separator so we need posixpath
-# for parsing them and we do need to replace / with os.sep when opening
-# the files.
-import os
 import posixpath
 import re
 
@@ -83,9 +79,8 @@ def update_end(filename, end):
     filename should be relative to the toplevel using / as a path
     separator.
     """
-    real_filename = filename.replace('/', os.sep)
     end = '\n***\n\n' + end
-    with open(real_filename, 'r') as f:
+    with common.slashfix_open(filename, 'r') as f:
         content = f.read()
     if content.endswith(end):
         # No need to do anything.
@@ -96,11 +91,11 @@ def update_end(filename, end):
         # We need to remove the old ending first.
         print("  Removing old end:", filename)
         where = content.index('\n***\n')
-        with open(real_filename, 'w') as f:
+        with common.slashfix_open(filename, 'w') as f:
             f.write(content[:where])
 
     print("  Adding end:", filename)
-    with open(real_filename, 'a') as f:
+    with common.slashfix_open(filename, 'a') as f:
         f.write(end)