Changeset 66517

Timestamp:

Oct 16, 2015, 8:44:52 AM (9 years ago)

Author:

wenzeslaus

Message:

Python port of description extraction for addons

The new version drops adding li end tag which was not working.
It also trips leading space and adds this to the caller script which
now adds space after colon.

Adding test files and script to quickly test the standalone script.

Location:

grass-addons/tools/addons

Files:

• get_page_description.py (moved) (moved from grass-addons/tools/addons/get_page_description.sh ) (1 diff)
• grass-addons-index.sh (modified) (1 diff)
• test (added)
• test/data (added)
• test/data/g.broken.example.html (added)
• test/data/r.group.page.html (added)
• test/data/r.standard.example.html (added)
• test/data/wxGUI.example.html (added)
• test/test_description_extraction.sh (added)

grass-addons/tools/addons/get_page_description.py

@@ -1 @@
-#!/bin/sh
+#!/usr/bin/env python
 
 # PURPOSE: Extracts page one line descriptions for index.html of GRASS GIS Addons
 
-# AUTHORS: Martin Landa
+# AUTHORS: Martin Landa (Bash version)
+#          Vaclav Petras (Python version)
 
-if [ $# -ne 1 ]; then
-    echo "$(basename $0) takes exactly one argument (HTML manual page name)"
-    exit 1
-fi
+import os
+import sys
+import re
 
-TMP=$$
 
-currfile=$1
+def get_desc_from_manual_page_line(text):
+    """
+    >>> get_desc_from_manual_page_line("r.example - This is a description<br>")
+    'This is a description'
+    """
+    # this matches the dash at the beginning
+    text = text.split(" - ", 1)[1]
+    # this matches a tag at the end
+    # (supposing no tags in the description and < represented as &lt;
+    text = text.split("<", 1)[0]
+    return text
 
-grep 'KEYWORDS' $currfile 2> /dev/null > /dev/null
-if [ $? -eq 0 ] ; then
-    # keywords found, so go ahead with extraction of one-line description
-    cat $currfile | awk '/NAME/,/KEYWORDS/' | grep ' - ' | cut -d'-' -f2- | cut -d'<' -f1 | sed 's+>$+></li>+g'  >> /tmp/d.$TMP
-    # argh, fake keyword line found (broken manual page or missing g.parser usage)
-    if [ ! -s /tmp/d.$TMP ] ; then
-        echo "(incomplete manual page, please fix; name part not found)" > /tmp/d.$TMP
-    fi
-    cat /tmp/d.$TMP
-    rm -f /tmp/d.$TMP
-else
-    # let's try to be more robust against missing keywords in a few HTML pages
-    # argh, no keywords found (broken manual page or missing g.parser usage)
-    echo "(incomplete manual page, please fix; keyword part not found)"
-fi
+
+def main(filename):
+    with open(filename) as page_file:
+        desc = None
+        in_desc_block = False
+        desc_block_start = re.compile(r'NAME')
+        desc_block_end = re.compile(r'KEYWORDS')
+        desc_line = re.compile(r' - ')
+        for line in page_file:
+            line = line.rstrip()  # remove '\n' at end of line
+            if desc_block_start.search(line):
+                in_desc_block = True
+            elif desc_block_end.search(line):
+                in_desc_block = False
+            if in_desc_block:
+                if desc_line.search(line):
+                    desc = get_desc_from_manual_page_line(line)
+        if not desc:
+            desc = "(incomplete manual page, please fix)"
+        # the original script attempted to add also </li> but it as not working
+        # now we leave up to the caller as well as whitespace around
+        print desc
+
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        sys.exit("{name} takes exactly one argument (HTML manual page name)."
+                 " {argc} parameters were given."
+                 .format(name=os.path.basename(sys.argv[0]),
+                                               argc=len(sys.argv) - 1))
+    sys.exit(main(sys.argv[1]))

grass-addons/tools/addons/grass-addons-index.sh

@@ -123 +123 @@
 
         module=`echo $currfile | sed 's+\.html$++g'`
-        echo "<li style=\"margin-left: 20px\"><a href=\"$currfile\">$module</a>:" >> index.html
-        ${SRC}grass-addons/tools/addons/get_page_description.sh $currfile >> index.html
+        echo "<li style=\"margin-left: 20px\"><a href=\"$currfile\">$module</a>: " >> index.html
+        ${SRC}grass-addons/tools/addons/get_page_description.py $currfile >> index.html
     done