epydoc-commits Mailing List for Python API documentation generation tool (Page 15)

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Revision: 1462
          http://svn.sourceforge.net/epydoc/?rev=1462&view=rev
Author:   edloper
Date:     2007-02-11 08:53:49 -0800 (Sun, 11 Feb 2007)

Log Message:
-----------
- Added options to control return value::

    --fail-on-error
    --fail-on-warning
    --fail-on-docstring-warning

  All three options cause epydoc to exit with status 1 if a message of
  the indicated level or higher is generated.  This can be useful for
  e.g., incorperation into makefiles.  (See sf bug 1558792)

Modified Paths:
--------------
    trunk/epydoc/src/epydoc/cli.py

Modified: trunk/epydoc/src/epydoc/cli.py
===================================================================

--- trunk/epydoc/src/epydoc/cli.py	2007-02-11 16:02:10 UTC (rev 1461)
+++ trunk/epydoc/src/epydoc/cli.py	2007-02-11 16:53:49 UTC (rev 1462)
@@ -92,6 +92,7 @@
     generation_group = OptionGroup(optparser, 'Generation options')
     output_group = OptionGroup(optparser, 'Output options')
     graph_group = OptionGroup(optparser, 'Graph options')
+    return_group = OptionGroup(optparser, 'Return value options')
 
     optparser.add_option(
         '--config', action='append', dest="configfiles", metavar='FILE',
@@ -252,11 +253,29 @@
              ("Run the hotshot profiler on epydoc itself.  Output "
               "will be written to profile.out."))
 
+    return_group.add_option(
+        "--fail-on-error", action="store_const", dest="fail_on",
+        const=log.ERROR,
+        help="Return a non-zero exit status, indicating failure, if any "
+        "errors are encountered.")
+    return_group.add_option(
+        "--fail-on-warning", action="store_const", dest="fail_on",
+        const=log.WARNING,
+        help="Return a non-zero exit status, indicating failure, if any "
+        "errors or warnings are encountered (not including docstring "
+        "warnings).")
+    return_group.add_option(
+        "--fail-on-docstring-warning", action="store_const", dest="fail_on",
+        const=log.DOCSTRING_WARNING,
+        help="Return a non-zero exit status, indicating failure, if any "
+        "errors or warnings are encountered (including docstring "
+        "warnings).")
     # Add the option groups.
     optparser.add_option_group(action_group)
     optparser.add_option_group(generation_group)
     optparser.add_option_group(output_group)
     optparser.add_option_group(graph_group)
+    optparser.add_option_group(return_group)
 
     # Set the option parser's defaults.
     optparser.set_defaults(action="html", show_frames=True,
@@ -269,7 +288,7 @@
                            graphs=[], list_classes_separately=False,
                            graph_font=None, graph_font_size=None,
                            include_source_code=True, pstat_files=[],
-                           simple_term=False)
+                           simple_term=False, fail_on=None)
 
     # Parse the arguments.
     options, names = optparser.parse_args()
@@ -417,6 +436,17 @@
             options.pstat_files.extend(val.replace(',', ' ').split())
         elif optname in ('simple-term', 'simple_term'):
             options.simple_term = _str_to_bool(val, optname)
+        elif optname in ('failon', 'fail-on', 'fail_on'):
+            if val.lower.strip() in ('error', 'errors'):
+                options.fail_on = log.ERROR
+            elif val.lower.strip() in ('warning', 'warnings'):
+                options.fail_on = log.WARNING
+            elif val.lower.strip() in ('docstring_warning',
+                                       'docstring_warnings'):
+                options.fail_on = log.DOCSTRING_WARNING
+            else:
+                raise ValueError("%r expected one of: error, warning, "
+                                 "docstring_warning" % optname)
         else:
             raise ValueError('Unknown option %s' % optname)
 
@@ -482,7 +512,8 @@
     if options.action not in ('text', 'check', 'pickle'):
         if os.path.exists(options.target):
             if not os.path.isdir(options.target):
-                return log.error("%s is not a directory" % options.target)
+                log.error("%s is not a directory" % options.target)
+                sys.exit(1)
 
     # Set the default docformat
     from epydoc import docstringparser
@@ -526,7 +557,10 @@
                                    exclude_parse=options.exclude_parse)
 
     if docindex is None:
-        return # docbuilder already logged an error.
+        if log.ERROR in logger.reported_message_levels:
+            sys.exit(1)
+        else:
+            return # docbuilder already logged an error.
 
     # Load profile information, if it was given.
     if options.pstat_files:
@@ -572,6 +606,13 @@
     if options.verbosity >= 2 and logger is not None:
         logger.print_times()
 
+    # If we encountered any message types that we were requested to
+    # fail on, then exit with status 1.
+    if options.fail_on is not None:
+        max_reported_message_level = max(logger.reported_message_levels)
+        if max_reported_message_level >= options.fail_on:
+            sys.exit(1)
+
 def write_html(docindex, options):
     from epydoc.docwriter.html import HTMLWriter
     html_writer = HTMLWriter(docindex, **options.__dict__)
@@ -721,6 +762,8 @@
             _profile()
         else:
             main(options, names)
+    except SystemExit:
+        raise
     except KeyboardInterrupt:
         print '\n\n'
         print >>sys.stderr, 'Keyboard interrupt.'
@@ -733,7 +776,7 @@
         print >>sys.stderr, ('\nUNEXPECTED ERROR:\n'
                              '%s\n' % (str(e) or e.__class__.__name__))
         print >>sys.stderr, 'Use --debug to see trace information.'
-
+    
 def _profile():
     # Hotshot profiler.
     if PROFILER == 'hotshot':
@@ -867,6 +910,11 @@
         # For per-task times:
         self._task_times = []
         self._progress_header = None
+
+        self.reported_message_levels = set()
+        """This set contains all the message levels (WARNING, ERROR,
+        etc) that have been reported.  It is used by the options
+        --fail-on-warning etc to determine the return value."""
         
         self.supressed_docstring_warning = 0
         """This variable will be incremented once every time a
@@ -932,6 +980,7 @@
         return color+prefix+self.term.NORMAL+''.join(lines)
 
     def log(self, level, message):
+        self.reported_message_levels.add(level)
         if self._verbosity >= -2 and level >= log.ERROR:
             message = self._format('  Error: ', message, self.term.RED)
         elif self._verbosity >= -1 and level >= log.WARNING:


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




2006	Jan	Feb	Mar	Apr (77)	May	Jun (6)	Jul (8)	Aug (91)	Sep (67)	Oct (4)	Nov	Dec (1)
2007	Jan (17)	Feb (135)	Mar (25)	Apr	May (1)	Jun (1)	Jul (7)	Aug	Sep (62)	Oct (1)	Nov (3)	Dec
2008	Jan (40)	Feb (102)	Mar (5)	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec
2009	Jan	Feb (2)	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec

epydoc-commits Mailing List for Python API documentation generation tool (Page 15)

epydoc-commits — CVS commit logs for the epydoc project