Merge pull request #520 from cchampet/fix_samDoExistIfError

* sam ls: fixed browses with filename and folders as inputs.
* sam do:
     * exit the process if there is an error in the command line
     * added 'default' constant to indicate the default value of Choice parameter
     * no ambiguity when calling a plugin with the exact id
     * fix print of the command line help even if there are arguments to process
* Fist tests of sam command line.

Author: cchampet

.travis.yml

@@ -80,8 +80,11 @@ addons:
     - swig
     - libboost1.55-all-dev
     - python-dev
+    - python-imaging
     - python-numpy
+    - python-nose
     - python3-dev
+    - python3-setuptools
     - python3-nose
     - libfreetype6-dev
     - libbz2-dev
@@ -97,8 +100,6 @@ addons:
     - libglew-dev
     - libgraphviz-dev
     - graphviz-dev
-    - python-nose
-    - python-imaging
     - libopenjpeg-dev
     - libturbojpeg
     - libxmu-dev

applications/CMakeLists.txt

@@ -3,3 +3,16 @@ add_subdirectory(sam)
 
 # scripts
 add_subdirectory(script)
+
+# Edit python scripts if the host is built with python3
+if(${TUTTLE_PYTHON_VERSION} VERSION_GREATER "3")
+    set(BASH_PYTHON2 "#!/usr/bin/env python")
+    set(BASH_PYTHON3 "#!/usr/bin/env python3")
+
+    file(GLOB_RECURSE PYTHON_APPS sam/*.py script/*.py)
+    foreach(PYTHON_APP ${PYTHON_APPS})
+        file(READ "${PYTHON_APP}" APP_CONTENT_PYTHON2)
+        string(REGEX REPLACE ${BASH_PYTHON2} ${BASH_PYTHON3} APP_CONTENT_PYTHON3  "${APP_CONTENT_PYTHON2}" )
+        file(WRITE "${PYTHON_APP}" "${APP_CONTENT_PYTHON3}")
+    endforeach()
+endif()

applications/sam/common/samDoUtils.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # coding: utf-8 
 
 import os
@@ -232,7 +231,12 @@ def getPluginName(self, logger):
             # get plugins name which match with the given id
             pluginNames = []
             for pluginName in pluginsMap:
-                if self._pluginId in pluginName:
+                # if the given id exactly matches the plugin id
+                # plugin id = plugin name without its group
+                if self._pluginId == pluginName[pluginName.rfind('.') + 1:]:
+                    return pluginName
+                # else if the given id is contains in the plugin name
+                elif self._pluginId in pluginName:
                     pluginNames.append(pluginName)
             # one plugin matches
             if len(pluginNames) == 1:

applications/sam/common/samUtils.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # coding: utf-8 
 
 import os
@@ -8,7 +7,7 @@
 # python module to get completions
 import argcomplete
 # python module to get colors
-from clint.textui import colored
+from clint.textui import colored, puts
 
 # parser of sequence
 from pySequenceParser import sequenceParser
@@ -81,6 +80,20 @@ def setLogLevel(self, tuttleVerboseLevel):
             else:
                 handler.setLevel(logging.WARNING)
 
+    def _displayCommandLineHelp(self, parser):
+        """
+        Display sam command line help.
+        """
+        if not self.command:
+            raise NotImplementedError
+
+        subparser = getSubParser(parser, self.command)
+        # if sam command is called from sam main command line
+        if subparser is not None:
+            puts(subparser.format_help())
+        else:
+            parser.print_help()
+
 
 class SamFormatter(logging.Formatter):
     """

applications/sam/sam_do.py

@@ -2,6 +2,7 @@
 # coding: utf-8 
 # PYTHON_ARGCOMPLETE_OK
 
+import sys
 import argparse
 import itertools
 
@@ -130,16 +131,29 @@ def _isCommandLineInvalid(self, inputsToProcess, inputsUnknown):
         @param inputsToProcess the 'inputs' arguments of the command line.
         @param inputsUnknown the 'inputs' arguments of the command line which are not recognized by argparse.
         """
-        # check if there is no arguments (or only the help option)
+        # check if there is no arguments
         if len(inputsToProcess) == 0:
-            if len(inputsUnknown) == 0 or '-h' in inputsUnknown or '--help' in inputsUnknown:
-                return True
-        # check if last input is the separator
-        if inputsToProcess[-1] == '//':
+            return True
+        # else check if last input is the separator
+        elif inputsToProcess[-1] == '//':
             self.logger.info('The given inputs to process are invalid: ' + str(inputsToProcess))
             return True
         return False
 
+    def _isCommandLineAskForHelp(self, inputsToProcess, inputsUnknown):
+        """
+        Returns if the given sam do command expects to print its help.
+        """
+        # check if there is no arguments
+        if len(inputsToProcess) == 0:
+            if len(inputsUnknown) == 0 or '-h' in inputsUnknown or '--help' in inputsUnknown:
+                return True
+        # else check unknow arguments
+        else:
+            if len(inputsUnknown) == 1 and ('-h' in inputsUnknown or '--help' in inputsUnknown):
+                return True
+        return False
+
     def _setTimeRanges(self, computeOptions, ranges):
         """
         Set time ranges of the given compute options.
@@ -300,7 +314,7 @@ def _displayParamHelp(self, param):
                 with indent(40):
                     for choiceValue in paramChoiceValues:
                         puts('{choiceValue!s:50} {label}'.format(
-                            choiceValue=(colored.yellow(choiceValue) if paramChoiceValues.index(choiceValue) == paramDefaultValue else colored.red(choiceValue)),
+                            choiceValue=(colored.yellow(choiceValue + ' (default)') if paramChoiceValues.index(choiceValue) == paramDefaultValue else colored.red(choiceValue)),
                             label=(paramChoiceLabel[paramChoiceValues.index(choiceValue)] if hasLabel else '')))
             else:
                 puts('{defaultValue!s:9}'.format(
@@ -343,6 +357,9 @@ def _displayNodeHelp(self, nodeFullName, node):
         """
         Display help of a specific node in the command line.
         """
+        if not node:
+            self.logger.error('Cannot print help of unknown plugin "' + nodeFullName + '".')
+            exit(1)
         # NODE
         self._displayTitle('NODE')
         with indent(4):
@@ -391,24 +408,14 @@ def _displayNodeHelp(self, nodeFullName, node):
                     name=colored.green('Output'),
                     bitdepth=', '.join(bitDepthOutputStr)))
 
-    def _displayCommandLineHelp(self, parser):
-        """
-        Display sam-do command line help.
-        """
-        subparser = samUtils.getSubParser(parser, 'do')
-        # if sam-do is called from sam main command line
-        if subparser is not None:
-            puts(subparser.format_help())
-        else:
-            parser.print_help()
-
     def _getTuttleGraph(self, splitCmdGraph):
         """
         Return the tuple (tuttle graph, its nodes) which corresponds to the given split command.
         """
         graph = tuttle.Graph()
         nodes = []
         connections = []
+        error = 0
 
         for splitCmdNode in splitCmdGraph.getNodes():
             # Create a tuttle node
@@ -421,9 +428,9 @@ def _getTuttleGraph(self, splitCmdGraph):
                 # Plugin not found
                 if not nodeFullName:
                     nodeFullName = splitCmdNode._pluginId
-                self.logger.error('Cannot create node "' + nodeFullName + '": the node will be skipped from the command line.')
+                self.logger.error('Cannot create node "' + nodeFullName + '".')
                 self.logger.debug(e)
-                continue
+                error = 1
             # sam-do node --help
             if splitCmdNode.hasHelp():
                 self._displayNodeHelp(nodeFullName, node)
@@ -447,22 +454,26 @@ def _getTuttleGraph(self, splitCmdGraph):
                             graph.connect(nodes[connections.index(argValue)], node.getAttribute(argName))
                         except Exception as e:
                             # Cannot connect attribute of node
-                            self.logger.warning('Cannot connect attribute "' 
-                                + argName + '" of node "' + nodeFullName 
-                                + '" to id "' + argValue 
-                                + '": the connection will be skipped from the command line.')
+                            self.logger.warning('Cannot connect attribute "'
+                                + argName + '" of node "' + nodeFullName
+                                + '" to id "' + argValue)
                             self.logger.debug(e)
+                            error = 1
                     else:
                         # Cannot set param of node
                         self.logger.warning('Cannot set '
                             + (('parameter "' + argName + '" of ') if argName else '')
-                            + 'node "' + nodeFullName + '" ' 
-                            + (('to value "' + argValue + '"') if argValue else '') 
-                            + ': the parameter will be skipped from the command line.')
+                            + 'node "' + nodeFullName + '" '
+                            + (('to value "' + argValue + '"') if argValue else ''))
                         self.logger.debug(e)
+                        error = 1
             nodes.append(node)
             connections.append(splitCmdNode.getArgument('id')[1])
 
+        # exit the process if there is an error in the command line
+        if error:
+            exit(error)
+
         # Create in line connections
         for i in range(0, len(connections)):
             if connections[i] is None and i+1 < len(connections):
@@ -478,6 +489,11 @@ def run(self, parser):
         # Parse command-line
         args, unknown = parser.parse_known_args()
 
+        # sam-do --help
+        if self._isCommandLineAskForHelp(args.inputs, unknown):
+            self._displayCommandLineHelp(parser)
+            exit(0)
+
         # Set sam log level
         self.setLogLevel(args.verbose)
         # set tuttle host log level
@@ -503,10 +519,10 @@ def run(self, parser):
             self._displayFileFormats()
             exit(0)
 
-        # sam-do --help
+        # Check sam-do command line
         if self._isCommandLineInvalid(args.inputs, unknown):
             self._displayCommandLineHelp(parser)
-            exit(0)
+            exit(1)
 
         # Add unknown options to the command line to process
         args.inputs.extend(unknown)

applications/sam/sam_ls.py

@@ -32,6 +32,15 @@ def __init__(self):
         self._sequenceExploded = [] # name of Sequences already exploded
 
     def fillParser(self, parser):
+        def level_type(level):
+            """
+            Check constrains of 'level' argument.
+            """
+            level = int(level)
+            if level < 0:
+                raise argparse.ArgumentTypeError("Minimum level is 0")
+            return level
+
         # Arguments
         parser.add_argument('inputs', nargs='*', action='store', help='list of files/sequences/directories to analyse').completer = samUtils.sequenceParserCompleter
 
@@ -45,7 +54,7 @@ def fillParser(self, parser):
         parser.add_argument('-l', '--long-listing', dest='longListing', action='store_true', help='use a long listing format (display in this order: type | permissions | owner | group | last update | minSize | maxSize | totalSize | name)')
         parser.add_argument('--format', dest='format', choices=['default', 'nuke', 'rv'], default='default', help='specify formatting of the sequence padding')
         parser.add_argument('-R', '--recursive', dest='recursive', action='store_true', help='handle directories and their content recursively')
-        parser.add_argument('-L', '--level', dest='level', type=int, help='max display depth of the directory tree (without formatting if 0)')
+        parser.add_argument('-L', '--level', dest='level', type=level_type, help='max display depth of the directory tree (without formatting if 0)')
         parser.add_argument('--absolute-path', dest='absolutePath', action='store_true', help='display the absolute path of each object')
         parser.add_argument('--relative-path', dest='relativePath', action='store_true', help='display the relative path of each object')
         parser.add_argument('--no-color', dest='noColor', action='store_true', default=False, help='display the output without colors (with colors by default)')
@@ -246,27 +255,44 @@ def run(self, parser):
         # Parse command-line
         args = parser.parse_args()
 
+        # sam-ls --absolute-path --relative-path
+        if args.absolutePath and args.relativePath:
+            self._displayCommandLineHelp(parser)
+            exit(1)
+
         # Set sam log level
         self.setLogLevel(args.verbose)
 
-        inputs = []
-        # for each input to scan
+        class InputToBrowse(object):
+            """
+            Represents an input to browse: a path and a list of filters.
+            """
+            def __init__(self, inputPath):
+                self.inputPath = inputPath
+                self.filters = []
+
+            def addFilter(self, filterToAdd):
+                self.filters.append(filterToAdd)
+
+        # translate user inputs to a list of InputToBrowse
+        inputsToBrowse = []
         for inputPath in args.inputs:
             # if the input is a directory, add it and continue
             if os.path.isdir(inputPath):
-                inputs.append(inputPath)
+                inputsToBrowse.append(InputToBrowse(inputPath))
                 continue
             # else split the input to a path and a filename
             subPath = os.path.dirname(inputPath)
             if not subPath:
                 subPath = '.'
             filename = os.path.basename(inputPath)
             # add the path and the filename as an expression
-            inputs.append(subPath)
-            if filename:
-                args.expression.append(filename)
-        if not inputs:
-            inputs.append(os.getcwd())
+            inputToBrowse = InputToBrowse(subPath)
+            inputToBrowse.addFilter(filename)
+            inputsToBrowse.append(inputToBrowse)
+        # if no user input, will browse in the current working directory
+        if not inputsToBrowse:
+            inputsToBrowse.append(InputToBrowse(os.getcwd()))
 
         # sam-ls -a
         detectionMethod = sequenceParser.eDetectionDefault
@@ -282,13 +308,15 @@ def run(self, parser):
             detectionMethod = detectionMethod | sequenceParser.eDetectionSequenceWithoutHoles
 
         # sam-ls -e
-        filters = []
         for expression in args.expression:
-            filters.append(expression)
+            for inputToBrowse in inputsToBrowse:
+                inputToBrowse.addFilter(expression)
 
-        # get list of items for each inputs
-        for inputPath in inputs:
+        # for each input to browse, print the finding items
+        for inputToBrowse in inputsToBrowse:
             items = []
+            inputPath = inputToBrowse.inputPath
+            filters = inputToBrowse.filters
             try:
                 self.logger.debug('Browse in "' + inputPath + '" with the following filters: ' + str(filters))
                 items = sequenceParser.browse(inputPath, detectionMethod, filters)
@@ -325,7 +353,7 @@ def run(self, parser):
                     items += sequenceParser.browse(newBrowsePath, detectionMethod, newFilter)
 
             if not len(items):
-                self.logger.warning('No items found for input "' + inputPath + '".')
+                self.logger.warning('No items found for input "' + inputPath + '" with the following filters: ' + str(filters))
             else:
                 self.printItems(items, args, detectionMethod, filters)