Experimental implementation for #279.

Author: metasim

pyrasterframes/src/main/python/setup.py

@@ -53,7 +53,8 @@ class PweaveDocs(distutils.cmd.Command):
     user_options = [
         # The format is (long option, short option, description).
         ('files=', 's', 'Specific files to pweave. Defaults to all in `docs` directory.'),
-        ('format=', 'f', 'Output format type. Defaults to `markdown`')
+        ('format=', 'f', 'Output format type. Defaults to `markdown`'),
+        ('quick=', 'q', 'Check to see if the source file is newer than existing output before building. Defaults to `False`.')
     ]
 
     def initialize_options(self):
@@ -64,6 +65,7 @@ def initialize_options(self):
             glob(path.join(here, 'docs', '*.pymd'))
         )
         self.format = 'markdown'
+        self.quick = False
 
     def finalize_options(self):
         """Post-process options."""
@@ -73,6 +75,11 @@ def finalize_options(self):
             # `html` doesn't do quite what one expects... only replaces code blocks, leaving markdown in place
             if self.format is 'html':
                 self.format = 'pandoc2html'
+        if isinstance(self.quick, str):
+            self.quick = self.quick == 'True' or self.quick == 'true'
+
+    def dest_file(self, src_file):
+        return path.splitext(src_file)[0] + '.md'
 
     def run(self):
         """Run pweave."""
@@ -82,33 +89,36 @@ def run(self):
 
         for file in self.files:
             name = path.splitext(path.basename(file))[0]
-            print(_divided('Running %s' % name))
-            try:
-                pweave.weave(
-                    file=str(file),
-                    doctype=self.format
-                )
-                if self.format == 'markdown':
-                    dest = path.splitext(file)[0] + '.md'
-                    if not path.exists(dest):
-                        raise FileNotFoundError("Markdown file '%s' didn't get created as expected" % dest)
-                    with open(dest, "r") as result:
-                        for (n, line) in enumerate(result):
-                            for word in bad_words:
-                                if word in line:
-                                    raise ChildProcessError("Error detected on line %s in %s:\n%s" % (n + 1, dest, line))
-
-            except Exception:
-                print(_divided('%s Failed:' % file))
-                print(traceback.format_exc())
-                exit(1)
+            dest = self.dest_file(file)
+
+            if (not self.quick) or (not path.exists(dest)) or (path.getmtime(dest) < path.getmtime(file)):
+                print(_divided('Running %s' % name))
+                try:
+                    pweave.weave(file=str(file), doctype=self.format)
+                    if self.format == 'markdown':
+                        if not path.exists(dest):
+                            raise FileNotFoundError("Markdown file '%s' didn't get created as expected" % dest)
+                        with open(dest, "r") as result:
+                            for (n, line) in enumerate(result):
+                                for word in bad_words:
+                                    if word in line:
+                                        raise ChildProcessError("Error detected on line %s in %s:\n%s" % (n + 1, dest, line))
+
+                except Exception:
+                    print(_divided('%s Failed:' % file))
+                    print(traceback.format_exc())
+                    exit(1)
+            else:
+                print(_divided('Skipping %s' % file))
 
 
 class PweaveNotebooks(PweaveDocs):
     def initialize_options(self):
         super().initialize_options()
         self.format = 'notebook'
 
+    def dest_file(self, src_file):
+        return path.splitext(src_file)[0] + '.ipynb'
 
 setup(
     name='pyrasterframes',