update vsc-base with support for --confighelp and (unused) bash tab completion support

Author: boegel

optcomplete.bash

@@ -0,0 +1,59 @@
+#******************************************************************************\
+# * Copyright (c) 2003-2004, Martin Blais
+# * All rights reserved.
+# *
+# * Redistribution and use in source and binary forms, with or without
+# * modification, are permitted provided that the following conditions are
+# * met:
+# *
+# * * Redistributions of source code must retain the above copyright
+# *   notice, this list of conditions and the following disclaimer.
+# *
+# * * Redistributions in binary form must reproduce the above copyright
+# *   notice, this list of conditions and the following disclaimer in the
+# *   documentation and/or other materials provided with the distribution.
+# *
+# * * Neither the name of the Martin Blais, Furius, nor the names of its
+# *   contributors may be used to endorse or promote products derived from
+# *   this software without specific prior written permission.
+# *
+# * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#******************************************************************************\
+#
+# stdweird: This is a copy of etc/optcomplete.bash (changeset 17:e0a9131a94cc)
+# stdweird:     source: https://hg.furius.ca/public/optcomplete
+#
+# optcomplete harness for bash shell. You then need to tell
+# bash to invoke this shell function with a command like
+# this:
+#
+#   complete -F _optcomplete <your command>
+#
+
+_optcomplete()
+{
+    # needed to let it return _filedir based commands
+    local cur prev quoted
+    _get_comp_words_by_ref cur prev
+    _quote_readline_by_ref "$cur" quoted
+    _expand || return 0
+
+    # call the command with the completion information, then eval it's results so it can call _filedir or similar
+    # this does have the potential to be a security problem, especially if running as root, but we should trust
+    # the completions as we're planning to run this script anyway
+    eval $( \
+            COMP_LINE=$COMP_LINE  COMP_POINT=$COMP_POINT \
+            COMP_WORDS="${COMP_WORDS[*]}"  COMP_CWORD=$COMP_CWORD \
+            OPTPARSE_AUTO_COMPLETE=1 $1
+        )
+}

setup.py

@@ -92,7 +92,7 @@ def find_rel_test():
     packages = easybuild_packages,
     package_dir = {'test.framework': "test/framework"},
     package_data = {"test.framework": find_rel_test()},
-    scripts = ["eb"],
+    scripts = ["eb", "optcomplete.bash"],
     data_files = [
         ('easybuild', ["easybuild/easybuild_config.py"]),
     ],

vsc/README.md

@@ -1,3 +1,3 @@
 Code from https://github.com/hpcugent/vsc-base
 
-based on 2f42ee01237ec7a7c1ef0247c2dbd64a5dae086c
+based on e48f33454b2f0daa26cdfd720ecb8e5e83259d37

vsc/__init__.py

@@ -31,9 +31,11 @@
 
 @author: Jens Timmerman (Ghent University)
 """
+#from pkgutil import extend_path
+
+# we're not the only ones in this namespace
 # avoid that EasyBuild uses vsc package from somewhere else, e.g. a system vsc-base installation
-#import pkg_resources
-#pkg_resources.declare_namespace(__name__)
+#__path__ = extend_path(__path__, __name__)  #@ReservedAssignment
 
 # here for backwards compatibility
 from vsc.utils import fancylogger

vsc/utils/dateandtime.py

@@ -31,11 +31,16 @@
 """
 
 import calendar
-import operator
 import re
 import time as _time
 from datetime import tzinfo, timedelta, datetime, date
 
+try:
+    any([0, 1])
+except:
+    from vsc.utils.missing import any
+
+
 class FancyMonth:
     """Convenience class for month math"""
     def __init__(self, tmpdate=None, year=None, month=None, day=None):
@@ -53,7 +58,6 @@ def __init__(self, tmpdate=None, year=None, month=None, day=None):
 
         self.date = date(year, month, day)
 
-
         self.first = None
         self.last = None
         self.nrdays = None
@@ -124,7 +128,7 @@ def get_start_end(self, otherdate):
     def number(self, otherdate):
         """Calculate the number of months between this month (date actually) and otherdate
         """
-        if self.include == False:
+        if self.include is False:
             msg = "number: include=False not implemented"
             raise(Exception(msg))
         else:
@@ -137,22 +141,22 @@ def number(self, otherdate):
 
         return nr
 
-    def get_other(self, shift= -1):
+    def get_other(self, shift=-1):
         """Return month that is shifted shift months: negative integer is in past, positive is in future"""
         new = self.date.year * 12 + self.date.month - 1 + shift
         return self.__class__(date(new // 12, new % 12 + 1, 01))
 
     def interval(self, otherdate):
         """Return time ordered list of months between date and otherdate"""
-        if self.include == False:
+        if self.include is False:
             msg = "interval: include=False not implemented"
             raise(Exception(msg))
         else:
             nr = self.number(otherdate)
             startdate, enddate = self.get_start_end(otherdate)
 
             start = self.__class__(startdate)
-            all_dates = [ start.get_other(m)  for m in range(nr)]
+            all_dates = [start.get_other(m) for m in range(nr)]
 
         return all_dates
 
@@ -192,6 +196,7 @@ def parser(self, txt):
 
         return res
 
+
 def date_parser(txt):
     """Parse txt
 
@@ -208,8 +213,10 @@ def date_parser(txt):
     if txt.endswith('MONTH'):
         m = FancyMonth()
         res = m.parser(txt)
-    elif reduce(operator.or_, testsupportedmonths):  # TODO replace with any()
-        m = FancyMonth(month=testsupportedmonths.index(True) + 1)
+    elif any(testsupportedmonths):
+        # set day=1 or this will fail on day's with an index more then the count of days then the month you want to parse
+        # e.g. will fail on 31'st when trying to parse april
+        m = FancyMonth(month=testsupportedmonths.index(True) + 1, day=1)
         res = m.parser(txt)
     elif txt in reserveddate:
         if txt in ('TODAY',):
@@ -229,6 +236,7 @@ def date_parser(txt):
 
     return res
 
+
 def datetime_parser(txt):
     """Parse txt: tmpdate YYYY-MM-DD HH:MM:SS.mmmmmm in datetime.datetime
         - date part is parsed with date_parser
@@ -255,6 +263,7 @@ def datetime_parser(txt):
 
     return res
 
+
 def timestamp_parser(timestamp):
     """Parse timestamp to datetime"""
     return datetime.fromtimestamp(float(timestamp))
@@ -267,8 +276,8 @@ def timestamp_parser(timestamp):
 ZERO = timedelta(0)
 HOUR = timedelta(hours=1)
 
-# A UTC class.
 
+# A UTC class.
 class UTC(tzinfo):
     """UTC"""
 
@@ -283,12 +292,14 @@ def dst(self, dt):
 
 utc = UTC()
 
-# A class building tzinfo objects for fixed-offset time zones.
-# Note that FixedOffset(0, "UTC") is a different way to build a
-# UTC tzinfo object.
 
 class FixedOffset(tzinfo):
-    """Fixed offset in minutes east from UTC."""
+    """Fixed offset in minutes east from UTC.
+
+    This is a class for building tzinfo objects for fixed-offset time zones.
+    Note that FixedOffset(0, "UTC") is a different way to build a
+    UTC tzinfo object.
+    """
     def __init__(self, offset, name):
         self.__offset = timedelta(minutes=offset)
         self.__name = name
@@ -302,17 +313,20 @@ def tzname(self, dt):
     def dst(self, dt):
         return ZERO
 
-# A class capturing the platform's idea of local time.
 
-STDOFFSET = timedelta(seconds= -_time.timezone)
+STDOFFSET = timedelta(seconds=-_time.timezone)
 if _time.daylight:
-    DSTOFFSET = timedelta(seconds= -_time.altzone)
+    DSTOFFSET = timedelta(seconds=-_time.altzone)
 else:
     DSTOFFSET = STDOFFSET
 
 DSTDIFF = DSTOFFSET - STDOFFSET
 
+
 class LocalTimezone(tzinfo):
+    """
+    A class capturing the platform's idea of local time.
+    """
 
     def utcoffset(self, dt):
         if self._isdst(dt):