cleaning up stuff

Akuli · Akuli · commit e182e8b7d0b2 · 2017-01-18T22:13:28.000+02:00
diff --git a/common.py b/common.py
@@ -30,7 +30,6 @@
 
 import itertools
 import re
-import sys
 
 
 _LINK_REGEX = r'\[(.*?)\]\((.*?)\)'
@@ -44,12 +43,12 @@ def find_links(file):
     # don't yield same link twice
     seen = set()
 
-    # we need to loop over the file two lines at a time to support 
+    # we need to loop over the file two lines at a time to support
     # multi-line (actually two-line) links, so this is kind of a mess
     firsts, seconds = itertools.tee(file)
     next(seconds)  # first line is never second line
 
-    # we want 1-based indexing instead of 0-based and one-line links get 
+    # we want 1-based indexing instead of 0-based and one-line links get
     # caught from linepair[1], so we need to start at two
     for lineno, linepair in enumerate(zip(firsts, seconds), start=2):
         lines = linepair[0] + linepair[1]
@@ -68,7 +67,7 @@ def get_markdown_files():
     with open('README.md', 'r') as f:
         for match, lineno in find_links(f):
             target = match.group(2)
-            # Currently the README doesn't link to itself, but I don't 
+            # Currently the README doesn't link to itself, but I don't
             # want to break things if it will in the future.
             if target.endswith('.md') and target != 'README.md':
                 yield target
diff --git a/linkcheck.py b/linkcheck.py
@@ -43,10 +43,8 @@
 
 # The markdown files use posix-style paths, so we need posixpath for
 # processing them. See help('posixpath').
-import collections
 import os
 import posixpath
-import re
 
 import common
 
@@ -64,15 +62,15 @@ def __init__(self, regexmatch, filepath, lineno):
 
     def _get_status(self):
         if self.target.startswith(('http://', 'https://')):
-            # Checking for http(s) links can be added later, but 
+            # Checking for http(s) links can be added later, but
             # currently it's not needed.
             return "ok"
 
         target = self.target
         if '#' in target:
             where = target.index('#')
             if where == 0:
-                # It's a link to a title in the same file, we need to 
+                # It's a link to a title in the same file, we need to
                 # skip it.
                 return "ok"
             target = target[:where]
@@ -84,7 +82,7 @@ def _get_status(self):
             return "doesn't exist"
         if target.endswith('/'):
             # A directory.
-            if os.path.isdir(directory):
+            if os.path.isdir(realpath):
                 return "ok"
             return "not a directory"
         else:
@@ -96,7 +94,7 @@ def _get_status(self):
     def check(self):
         """Check if the link's target is like it should be.
 
-        Return an error message string or "ok". The return value is also 
+        Return an error message string or "ok". The return value is also
         assigned to the status attribute.
         """
         self.status = self._get_status()
diff --git a/strip.py b/strip.py
@@ -28,11 +28,13 @@
 
 """Strip trailing whitespace from markdown files."""
 
+import os
+
 import common
 
 
-def needs_stripping(file):
-    with open(file, 'r') as f:
+def needs_stripping(realfile):
+    with open(realfile, 'r') as f:
         for line in f:
             line = line.rstrip('\n')
             if line != line.rstrip():
@@ -41,21 +43,22 @@ def needs_stripping(file):
     return False
 
 
-def strip(file):
+def strip(realfile):
     lines = []
-    with open(file, 'r') as f:
+    with open(realfile, 'r') as f:
         for line in f:
             lines.append(line.rstrip())
-    with open(file, 'w') as f:
+    with open(realfile, 'w') as f:
         for line in lines:
             print(line, file=f)
 
 
 def main():
     print("Stripping trailing whitespace...")
     for file in common.get_markdown_files():
-        if needs_stripping(file):
-            strip(file)
+        realfile = file.replace('/', os.sep)
+        if needs_stripping(realfile):
+            strip(realfile)
             print("  Was stripped:", file)
         else:
             print("  No trailing whitespace:", file)
diff --git a/update-ends.py b/update-ends.py
@@ -28,9 +28,10 @@
 
 """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 
+# 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
 
@@ -50,7 +51,7 @@
 def get_filenames():
     """Get chapter files and other files from README.
 
-    Return a two-tuple of chapter file names and other file names as 
+    Return a two-tuple of chapter file names and other file names as
     iterables of strings.
     """
     chapters = []
@@ -79,12 +80,12 @@ def get_filenames():
 def update_end(filename, end):
     """Add *** and end to a file if it doesn't have them already.
 
-    filename should be relative to the toplevel using / as a path 
+    filename should be relative to the toplevel using / as a path
     separator.
     """
-    filename = filename
+    real_filename = filename.replace('/', os.sep)
     end = '\n***\n\n' + end
-    with open(filename, 'r') as f:
+    with open(real_filename, 'r') as f:
         content = f.read()
     if content.endswith(end):
         # No need to do anything.
@@ -95,11 +96,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(filename, 'w') as f:
+        with open(real_filename, 'w') as f:
             f.write(content[:where])
 
     print("  Adding end:", filename)
-    with open(filename, 'a') as f:
+    with open(real_filename, 'a') as f:
         f.write(end)
 
 
@@ -108,34 +109,15 @@ def main():
 
     # make previous of first file and next of last file to just bring
     # back to README
-    prevs = ['./README.md'] + chapter_files[:-1]
-    nexts = chapter_files[1:] + ['./README.md']
+    prevs = ['README.md'] + chapter_files[:-1]
+    nexts = chapter_files[1:] + ['README.md']
 
     print("Chapter files:")
     for prevpath, thispath, nextpath in zip(prevs, chapter_files, nexts):
-        # the paths are like 'section/file.md'
-        prevsection, prevfile = posixpath.split(prevpath)
-        thissection, thisfile = posixpath.split(thispath)
-        nextsection, nextfile = posixpath.split(nextpath)
-
-        # make previous and next relative to this file
-        if prevsection == thissection:
-            # they are in the same place
-            prev = prevfile
-        elif prevsection == '.':
-            # something from the top level
-            prev = posixpath.join('..', prevfile)
-        else:
-            # it comes from some other place
-            prev = posixpath.join('..', prevpath)
-
-        if nextsection == thissection:
-            next_ = nextfile
-        elif nextsection == '.':
-            next_ = posixpath.join('..', nextfile)
-        else:
-            next_ = posixpath.join('..', nextpath)
-
+        # thispath is always like 'section/file.md', never e.g. 'README.md'
+        thissection, thisfile = thispath.split('/')
+        prev = posixpath.relpath(prevpath, thissection)
+        next_ = posixpath.relpath(nextpath, thissection)
         extralinks = "[Previous](%s) | [Next](%s) |\n" % (prev, next_)
         end = END_TEMPLATE.format(
             license='../LICENSE', readme='../README.md',
