Transform: Extract link map functionality into a reusable class

Author: p12tic

build_link_map.py

@@ -24,6 +24,7 @@
 import lxml.etree as e
 import re
 import os
+from link_map import LinkMap
 
 # returns a dict { title -> filename }.
 # directory - either 'output/reference' or 'reference'
@@ -34,7 +35,7 @@ def build_link_map(directory):
         for filename in fnmatch.filter(filenames, '*.html'):
             html_files.append(os.path.join(root, filename))
 
-    link_map = {}
+    link_map = LinkMap()
 
     for fn in html_files:
         f = open(fn, "r")
@@ -53,24 +54,14 @@ def build_link_map(directory):
         title = m.group(1)
 
         target = os.path.relpath(os.path.abspath(fn), os.path.abspath(directory))
-        link_map[title] = target
+        link_map.add_link(title, target)
     return link_map
 
 def main():
     link_map = build_link_map('output/reference')
 
     # create an xml file containing mapping between page title and actual location
-    root = e.Element('files')
-
-    for key in link_map:
-        file_el = e.SubElement(root, 'file')
-        file_el.set('from', key)
-        file_el.set('to', link_map[key])
-
-    out = open('output/link-map.xml', 'w')
-    out.write('<?xml version="1.0" encoding="UTF-8"?>')
-    out.write(e.tostring(root, encoding=str, pretty_print=True))
-    out.close()
+    link_map.write('output/link-map.xml')
 
 if __name__ == "__main__":
     main()

fix_devhelp-links.py

@@ -19,6 +19,7 @@
 '''
 
 import lxml.etree as e
+from link_map import LinkMap
 import sys
 
 if len(sys.argv) != 3:
@@ -30,27 +31,19 @@
 in_fn = sys.argv[1]
 out_fn = sys.argv[2]
 
-root = e.parse('output/link-map.xml')
-el_files = root.xpath('/files/*')
-
-mapping = dict()
-
-for el_file in el_files:
-    fn_from = el_file.get('from')
-    fn_to = el_file.get('to')
-    mapping[fn_from] = fn_to
+mapping = LinkMap()
+mapping.read('output/link-map.xml')
 
 root = e.parse(in_fn)
 
 el_mod = root.xpath('//*[@link]')
 for el in el_mod:
     link = el.get('link')
-    try:
-        link = mapping[link]
-    except:
+    target = mapping.get_dest(link)
+    if target == None:
         print('Could not find ' + link + ' in mapping')
-        link = '404'
-    el.set('link', link)
+        target = '404'
+    el.set('link', target)
 
 out_f = open(out_fn, 'w')
 out_f.write(e.tostring(root, encoding='unicode', pretty_print=True))

link_map.py

@@ -0,0 +1,58 @@
+#!/usr/bin/env python3
+'''
+    Copyright (C) 2012-2014  Povilas Kanapickas <[email protected]>
+
+    This file is part of cppreference-doc
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see http://www.gnu.org/licenses/.
+'''
+
+import lxml.etree as e
+
+class LinkMap:
+    def __init__(self):
+        self.mapping = dict()
+
+    def read(self, fn):
+        root = e.parse(fn)
+        el_files = root.xpath('/files/*')
+
+        self.mapping = dict()
+
+        for el_file in el_files:
+            fn_from = el_file.get('from')
+            fn_to = el_file.get('to')
+            self.mapping[fn_from] = fn_to
+
+    def write(self, fn):
+        root = e.Element('files')
+
+        for key in self.mapping:
+            file_el = e.SubElement(root, 'file')
+            file_el.set('from', key)
+            file_el.set('to', self.mapping[key])
+
+        out = open(fn, 'w')
+        out.write('<?xml version="1.0" encoding="UTF-8"?>')
+        out.write(e.tostring(root, encoding=str, pretty_print=True))
+        out.close()
+
+    # Returns None on failure
+    def get_dest(self, target):
+        if target in self.mapping:
+            return self.mapping[target]
+        return None
+
+    def add_link(self, title, target):
+        self.mapping[title] = target