STCC-251 Jython Libraries

Updated the libraries that are used in jython.
docopt from 0.6.1 to 0.6.2
progressbar from 2.3 to 2.5

Author: 11possim

src/docopt.py

@@ -11,7 +11,7 @@
 
 
 __all__ = ['docopt']
-__version__ = '0.6.1'
+__version__ = '0.6.2'
 
 
 class DocoptLanguageError(Exception):
@@ -47,18 +47,18 @@ def fix_identities(self, uniq=None):
         if not hasattr(self, 'children'):
             return self
         uniq = list(set(self.flat())) if uniq is None else uniq
-        for i, child in enumerate(self.children):
-            if not hasattr(child, 'children'):
-                assert child in uniq
-                self.children[i] = uniq[uniq.index(child)]
+        for i, c in enumerate(self.children):
+            if not hasattr(c, 'children'):
+                assert c in uniq
+                self.children[i] = uniq[uniq.index(c)]
             else:
-                child.fix_identities(uniq)
+                c.fix_identities(uniq)
 
     def fix_repeating_arguments(self):
         """Fix elements that should accumulate/increment values."""
-        either = [list(child.children) for child in transform(self).children]
+        either = [list(c.children) for c in self.either.children]
         for case in either:
-            for e in [child for child in case if case.count(child) > 1]:
+            for e in [c for c in case if case.count(c) > 1]:
                 if type(e) is Argument or type(e) is Option and e.argcount:
                     if e.value is None:
                         e.value = []
@@ -68,40 +68,47 @@ def fix_repeating_arguments(self):
                     e.value = 0
         return self
 
-
-def transform(pattern):
-    """Expand pattern into an (almost) equivalent one, but with single Either.
-
-    Example: ((-a | -b) (-c | -d)) => (-a -c | -a -d | -b -c | -b -d)
-    Quirks: [-a] => (-a), (-a...) => (-a -a)
-
-    """
-    result = []
-    groups = [[pattern]]
-    while groups:
-        children = groups.pop(0)
-        parents = [Required, Optional, OptionsShortcut, Either, OneOrMore]
-        if any(t in map(type, children) for t in parents):
-            child = [c for c in children if type(c) in parents][0]
-            children.remove(child)
-            if type(child) is Either:
-                for c in child.children:
+    @property
+    def either(self):
+        """Transform pattern into an equivalent, with only top-level Either."""
+        # Currently the pattern will not be equivalent, but more "narrow",
+        # although good enough to reason about list arguments.
+        ret = []
+        groups = [[self]]
+        while groups:
+            children = groups.pop(0)
+            types = [type(c) for c in children]
+            if Either in types:
+                either = [c for c in children if type(c) is Either][0]
+                children.pop(children.index(either))
+                for c in either.children:
                     groups.append([c] + children)
-            elif type(child) is OneOrMore:
-                groups.append(child.children * 2 + children)
+            elif Required in types:
+                required = [c for c in children if type(c) is Required][0]
+                children.pop(children.index(required))
+                groups.append(list(required.children) + children)
+            elif Optional in types:
+                optional = [c for c in children if type(c) is Optional][0]
+                children.pop(children.index(optional))
+                groups.append(list(optional.children) + children)
+            elif AnyOptions in types:
+                optional = [c for c in children if type(c) is AnyOptions][0]
+                children.pop(children.index(optional))
+                groups.append(list(optional.children) + children)
+            elif OneOrMore in types:
+                oneormore = [c for c in children if type(c) is OneOrMore][0]
+                children.pop(children.index(oneormore))
+                groups.append(list(oneormore.children) * 2 + children)
             else:
-                groups.append(child.children + children)
-        else:
-            result.append(children)
-    return Either(*[Required(*e) for e in result])
+                ret.append(children)
+        return Either(*[Required(*e) for e in ret])
 
 
-class LeafPattern(Pattern):
-
-    """Leaf/terminal node of a pattern tree."""
+class ChildPattern(Pattern):
 
     def __init__(self, name, value=None):
-        self.name, self.value = name, value
+        self.name = name
+        self.value = value
 
     def __repr__(self):
         return '%s(%r, %r)' % (self.__class__.__name__, self.name, self.value)
@@ -130,9 +137,7 @@ def match(self, left, collected=None):
         return True, left_, collected + [match]
 
 
-class BranchPattern(Pattern):
-
-    """Branch/inner node of a pattern tree."""
+class ParentPattern(Pattern):
 
     def __init__(self, *children):
         self.children = list(children)
@@ -144,15 +149,15 @@ def __repr__(self):
     def flat(self, *types):
         if type(self) in types:
             return [self]
-        return sum([child.flat(*types) for child in self.children], [])
+        return sum([c.flat(*types) for c in self.children], [])
 
 
-class Argument(LeafPattern):
+class Argument(ChildPattern):
 
     def single_match(self, left):
-        for n, pattern in enumerate(left):
-            if type(pattern) is Argument:
-                return n, Argument(self.name, pattern.value)
+        for n, p in enumerate(left):
+            if type(p) is Argument:
+                return n, Argument(self.name, p.value)
         return None, None
 
     @classmethod
@@ -165,23 +170,25 @@ def parse(class_, source):
 class Command(Argument):
 
     def __init__(self, name, value=False):
-        self.name, self.value = name, value
+        self.name = name
+        self.value = value
 
     def single_match(self, left):
-        for n, pattern in enumerate(left):
-            if type(pattern) is Argument:
-                if pattern.value == self.name:
+        for n, p in enumerate(left):
+            if type(p) is Argument:
+                if p.value == self.name:
                     return n, Command(self.name, True)
                 else:
                     break
         return None, None
 
 
-class Option(LeafPattern):
+class Option(ChildPattern):
 
     def __init__(self, short=None, long=None, argcount=0, value=False):
         assert argcount in (0, 1)
-        self.short, self.long, self.argcount = short, long, argcount
+        self.short, self.long = short, long
+        self.argcount, self.value = argcount, value
         self.value = None if value is False and argcount else value
 
     @classmethod
@@ -202,9 +209,9 @@ def parse(class_, option_description):
         return class_(short, long, argcount, value)
 
     def single_match(self, left):
-        for n, pattern in enumerate(left):
-            if self.name == pattern.name:
-                return n, pattern
+        for n, p in enumerate(left):
+            if self.name == p.name:
+                return n, p
         return None, None
 
     @property
@@ -216,34 +223,34 @@ def __repr__(self):
                                            self.argcount, self.value)
 
 
-class Required(BranchPattern):
+class Required(ParentPattern):
 
     def match(self, left, collected=None):
         collected = [] if collected is None else collected
         l = left
         c = collected
-        for pattern in self.children:
-            matched, l, c = pattern.match(l, c)
+        for p in self.children:
+            matched, l, c = p.match(l, c)
             if not matched:
                 return False, left, collected
         return True, l, c
 
 
-class Optional(BranchPattern):
+class Optional(ParentPattern):
 
     def match(self, left, collected=None):
         collected = [] if collected is None else collected
-        for pattern in self.children:
-            m, left, collected = pattern.match(left, collected)
+        for p in self.children:
+            m, left, collected = p.match(left, collected)
         return True, left, collected
 
 
-class OptionsShortcut(Optional):
+class AnyOptions(Optional):
 
     """Marker/placeholder for [options] shortcut."""
 
 
-class OneOrMore(BranchPattern):
+class OneOrMore(ParentPattern):
 
     def match(self, left, collected=None):
         assert len(self.children) == 1
@@ -265,32 +272,26 @@ def match(self, left, collected=None):
         return False, left, collected
 
 
-class Either(BranchPattern):
+class Either(ParentPattern):
 
     def match(self, left, collected=None):
         collected = [] if collected is None else collected
         outcomes = []
-        for pattern in self.children:
-            matched, _, _ = outcome = pattern.match(left, collected)
+        for p in self.children:
+            matched, _, _ = outcome = p.match(left, collected)
             if matched:
                 outcomes.append(outcome)
         if outcomes:
             return min(outcomes, key=lambda outcome: len(outcome[1]))
         return False, left, collected
 
 
-class Tokens(list):
+class TokenStream(list):
 
-    def __init__(self, source, error=DocoptExit):
+    def __init__(self, source, error):
         self += source.split() if hasattr(source, 'split') else source
         self.error = error
 
-    @staticmethod
-    def from_pattern(source):
-        source = re.sub(r'([\[\]\(\)\|]|\.\.\.)', r' \1 ', source)
-        source = [s for s in re.split('\s+|(\S*<.*?>)', source) if s]
-        return Tokens(source, error=DocoptLanguageError)
-
     def move(self):
         return self.pop(0) if len(self) else None
 
@@ -323,7 +324,7 @@ def parse_long(tokens, options):
                 raise tokens.error('%s must not have an argument' % o.long)
         else:
             if value is None:
-                if tokens.current() in [None, '--']:
+                if tokens.current() is None:
                     raise tokens.error('%s requires argument' % o.long)
                 value = tokens.move()
         if tokens.error is DocoptExit:
@@ -354,7 +355,7 @@ def parse_shorts(tokens, options):
             value = None
             if o.argcount != 0:
                 if left == '':
-                    if tokens.current() in [None, '--']:
+                    if tokens.current() is None:
                         raise tokens.error('%s requires argument' % short)
                     value = tokens.move()
                 else:
@@ -367,7 +368,8 @@ def parse_shorts(tokens, options):
 
 
 def parse_pattern(source, options):
-    tokens = Tokens.from_pattern(source)
+    tokens = TokenStream(re.sub(r'([\[\]\(\)\|]|\.\.\.)', r' \1 ', source),
+                         DocoptLanguageError)
     result = parse_expr(tokens, options)
     if tokens.current() is not None:
         raise tokens.error('unexpected ending: %r' % ' '.join(tokens))
@@ -414,7 +416,7 @@ def parse_atom(tokens, options):
         return [result]
     elif token == 'options':
         tokens.move()
-        return [OptionsShortcut()]
+        return [AnyOptions()]
     elif token.startswith('--') and token != '--':
         return parse_long(tokens, options)
     elif token.startswith('-') and token not in ('-', '--'):
@@ -450,26 +452,27 @@ def parse_argv(tokens, options, options_first=False):
 
 
 def parse_defaults(doc):
-    defaults = []
-    for s in parse_section('options:', doc):
-        # FIXME corner case "bla: options: --foo"
-        _, _, s = s.partition(':')  # get rid of "options:"
-        split = re.split('\n[ \t]*(-\S+?)', '\n' + s)[1:]
-        split = [s1 + s2 for s1, s2 in zip(split[::2], split[1::2])]
-        options = [Option.parse(s) for s in split if s.startswith('-')]
-        defaults += options
-    return defaults
-
-
-def parse_section(name, source):
-    pattern = re.compile('^([^\n]*' + name + '[^\n]*\n?(?:[ \t].*?(?:\n|$))*)',
-                         re.IGNORECASE | re.MULTILINE)
-    return [s.strip() for s in pattern.findall(source)]
-
-
-def formal_usage(section):
-    _, _, section = section.partition(':')  # drop "usage:"
-    pu = section.split()
+    # in python < 2.7 you can't pass flags=re.MULTILINE
+    split = re.split('\n *(<\S+?>|-\S+?)', doc)[1:]
+    split = [s1 + s2 for s1, s2 in zip(split[::2], split[1::2])]
+    options = [Option.parse(s) for s in split if s.startswith('-')]
+    #arguments = [Argument.parse(s) for s in split if s.startswith('<')]
+    #return options, arguments
+    return options
+
+
+def printable_usage(doc):
+    # in python < 2.7 you can't pass flags=re.IGNORECASE
+    usage_split = re.split(r'([Uu][Ss][Aa][Gg][Ee]:)', doc)
+    if len(usage_split) < 3:
+        raise DocoptLanguageError('"usage:" (case-insensitive) not found.')
+    if len(usage_split) > 3:
+        raise DocoptLanguageError('More than one "usage:" (case-insensitive).')
+    return re.split(r'\n\s*\n', ''.join(usage_split[1:]))[0].strip()
+
+
+def formal_usage(printable_usage):
+    pu = printable_usage.split()[1:]  # split and drop "usage:"
     return '( ' + ' '.join(') | (' if s == pu[0] else s for s in pu[1:]) + ' )'
 
 
@@ -509,7 +512,7 @@ def docopt(doc, argv=None, help=True, version=None, options_first=False):
         If passed, the object will be printed if --version is in
         `argv`.
     options_first : bool (default: False)
-        Set to True to require options precede positional arguments,
+        Set to True to require options preceed positional arguments,
         i.e. to forbid options and positional arguments intermix.
 
     Returns
@@ -523,15 +526,15 @@ def docopt(doc, argv=None, help=True, version=None, options_first=False):
     -------
     >>> from docopt import docopt
     >>> doc = '''
-    ... Usage:
-    ...     my_program tcp <host> <port> [--timeout=<seconds>]
-    ...     my_program serial <port> [--baud=<n>] [--timeout=<seconds>]
-    ...     my_program (-h | --help | --version)
-    ...
-    ... Options:
-    ...     -h, --help  Show this screen and exit.
-    ...     --baud=<n>  Baudrate [default: 9600]
-    ... '''
+    Usage:
+        my_program tcp <host> <port> [--timeout=<seconds>]
+        my_program serial <port> [--baud=<n>] [--timeout=<seconds>]
+        my_program (-h | --help | --version)
+
+    Options:
+        -h, --help  Show this screen and exit.
+        --baud=<n>  Baudrate [default: 9600]
+    '''
     >>> argv = ['tcp', '127.0.0.1', '80', '--timeout', '30']
     >>> docopt(doc, argv)
     {'--baud': '9600',
@@ -550,32 +553,27 @@ def docopt(doc, argv=None, help=True, version=None, options_first=False):
       at https://github.com/docopt/docopt#readme
 
     """
-    argv = sys.argv[1:] if argv is None else argv
-
-    usage_sections = parse_section('usage:', doc)
-    if len(usage_sections) == 0:
-        raise DocoptLanguageError('"usage:" (case-insensitive) not found.')
-    if len(usage_sections) > 1:
-        raise DocoptLanguageError('More than one "usage:" (case-insensitive).')
-    DocoptExit.usage = usage_sections[0]
-
+    if argv is None:
+        argv = sys.argv[1:]
+    DocoptExit.usage = printable_usage(doc)
     options = parse_defaults(doc)
     pattern = parse_pattern(formal_usage(DocoptExit.usage), options)
     # [default] syntax for argument is disabled
     #for a in pattern.flat(Argument):
     #    same_name = [d for d in arguments if d.name == a.name]
     #    if same_name:
     #        a.value = same_name[0].value
-    argv = parse_argv(Tokens(argv), list(options), options_first)
+    argv = parse_argv(TokenStream(argv, DocoptExit), list(options),
+                      options_first)
     pattern_options = set(pattern.flat(Option))
-    for options_shortcut in pattern.flat(OptionsShortcut):
+    for ao in pattern.flat(AnyOptions):
         doc_options = parse_defaults(doc)
-        options_shortcut.children = list(set(doc_options) - pattern_options)
+        ao.children = list(set(doc_options) - pattern_options)
         #if any_options:
-        #    options_shortcut.children += [Option(o.short, o.long, o.argcount)
+        #    ao.children += [Option(o.short, o.long, o.argcount)
         #                    for o in argv if type(o) is Option]
     extras(help, version, argv, doc)
     matched, left, collected = pattern.fix().match(argv)
     if matched and left == []:  # better error message if left?
         return Dict((a.name, a.value) for a in (pattern.flat() + collected))
-    raise DocoptExit()
+    raise DocoptExit()

src/progressbar/__init__.py

@@ -40,10 +40,10 @@
 """
 
 __author__ = 'Nilton Volpato'
-__author_email__ = 'first-name dot last-name @ gmail.com'
+__author_email__ = 'nilton.volpato@gmail.com'
 __date__ = '2011-05-14'
-__version__ = '2.3'
+__version__ = '2.5'
 
-from compat import *
-from widgets import *
-from progressbar import *
+from .compat import *
+from .widgets import *
+from .progressbar import *

src/progressbar/compat.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
 # progressbar  - Text progress bar library for Python.

src/progressbar/progressbar.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
 # progressbar  - Text progress bar library for Python.
@@ -35,11 +34,8 @@
 except ImportError:
     pass
 
-from compat import *  # for: any, next
-import widgets
-
-
-class UnknownLength: pass
+from .compat import *  # for: any, next
+from . import widgets
 
 
 class ProgressBar(object):
@@ -96,7 +92,7 @@ class ProgressBar(object):
     _DEFAULT_WIDGETS = [widgets.Percentage(), ' ', widgets.Bar()]
 
     def __init__(self, maxval=None, widgets=None, term_width=None, poll=1,
-                 left_justify=True, fd=sys.stderr):
+                 left_justify=True, fd=None):
         """Initializes a progress bar with sane defaults."""
 
         # Don't share a reference with any other progress bars
@@ -105,7 +101,7 @@ def __init__(self, maxval=None, widgets=None, term_width=None, poll=1,
 
         self.maxval = maxval
         self.widgets = widgets
-        self.fd = fd
+        self.fd = fd if fd is not None else sys.stderr
         self.left_justify = left_justify
 
         self.signal_set = False
@@ -139,7 +135,7 @@ def __call__(self, iterable):
             self.maxval = len(iterable)
         except:
             if self.maxval is None:
-                self.maxval = UnknownLength
+                self.maxval = widgets.UnknownLength
 
         self.__iterable = iter(iterable)
         return self
@@ -184,9 +180,11 @@ def _handle_resize(self, signum=None, frame=None):
 
     def percentage(self):
         """Returns the progress as a percentage."""
+        if self.maxval is widgets.UnknownLength:
+                return float("NaN")
         if self.currval >= self.maxval:
             return 100.0
-        return self.currval * 100.0 / self.maxval
+        return (self.currval * 100.0 / self.maxval) if self.maxval else 100.00
 
     percent = property(percentage)
 
@@ -245,8 +243,8 @@ def _update_widgets(self):
     def update(self, value=None):
         """Updates the ProgressBar to a new value."""
 
-        if value is not None and value is not UnknownLength:
-            if (self.maxval is not UnknownLength
+        if value is not None and value is not widgets.UnknownLength:
+            if (self.maxval is not widgets.UnknownLength
                 and not 0 <= value <= self.maxval):
 
                 raise ValueError('Value out of range')
@@ -262,6 +260,7 @@ def update(self, value=None):
         self.seconds_elapsed = now - self.start_time
         self.next_update = self.currval + self.update_interval
         self.fd.write(self._format_line() + '\r')
+        self.fd.flush()
         self.last_update_time = now
 
 
@@ -283,7 +282,7 @@ def start(self):
         self.num_intervals = max(100, self.term_width)
         self.next_update = 0
 
-        if self.maxval is not UnknownLength:
+        if self.maxval is not widgets.UnknownLength:
             if self.maxval < 0: raise ValueError('Value out of range')
             self.update_interval = self.maxval / self.num_intervals
 

src/progressbar/widgets.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
 # progressbar  - Text progress bar library for Python.
@@ -33,6 +32,8 @@
 else:
     AbstractWidget = ABCMeta('AbstractWidget', (object,), {})
 
+class UnknownLength:
+  pass
 
 def format_updatable(updatable, pbar):
     if hasattr(updatable, 'update'): return updatable.update(pbar)
@@ -108,7 +109,7 @@ class ETA(Timer):
     def update(self, pbar):
         """Updates the widget to show the ETA or total time when finished."""
 
-        if pbar.currval == 0:
+        if pbar.maxval is UnknownLength or pbar.currval == 0:
             return 'ETA:  --:--:--'
         elif pbar.finished:
             return 'Time: %s' % self.format_time(pbar.seconds_elapsed)
@@ -123,7 +124,7 @@ class AdaptiveETA(Timer):
 
     Uses a weighted average of two estimates:
       1) ETA based on the total progress and time elapsed so far
-      2) ETA based on the progress as per tha last 10 update reports
+      2) ETA based on the progress as per the last 10 update reports
 
     The weight depends on the current progress so that to begin with the
     total progress is used and at the end only the most recent progress is
@@ -146,7 +147,7 @@ def _eta(self, maxval, currval, elapsed):
 
     def update(self, pbar):
         """Updates the widget to show the ETA or total time when finished."""
-        if pbar.currval == 0:
+        if pbar.maxval is UnknownLength or pbar.currval == 0:
             return 'ETA:  --:--:--'
         elif pbar.finished:
             return 'Time: %s' % self.format_time(pbar.seconds_elapsed)
@@ -166,7 +167,7 @@ def update(self, pbar):
 class FileTransferSpeed(Widget):
     """Widget for showing the transfer speed (useful for file transfers)."""
 
-    FORMAT = '%6.2f %s%s/s'
+    FMT = '%6.2f %s%s/s'
     PREFIXES = ' kMGTPEZY'
     __slots__ = ('unit',)
 
@@ -183,7 +184,7 @@ def update(self, pbar):
             power = int(math.log(speed, 1000))
             scaled = speed / 1000.**power
 
-        return self.FORMAT % (scaled, self.PREFIXES[power], self.unit)
+        return self.FMT % (scaled, self.PREFIXES[power], self.unit)
 
 
 class AnimatedMarker(Widget):
@@ -270,7 +271,7 @@ def __init__(self, sep=' of '):
         self.sep = sep
 
     def update(self, pbar):
-        return '%d%s%d' % (pbar.currval, self.sep, pbar.maxval)
+        return '%d%s%s' % (pbar.currval, self.sep, pbar.maxval)
 
 
 class Bar(WidgetHFill):
@@ -303,7 +304,7 @@ def update(self, pbar, width):
 
         width -= len(left) + len(right)
         # Marked must *always* have length of 1
-        if pbar.maxval:
+        if pbar.maxval is not UnknownLength and pbar.maxval:
           marked *= int(pbar.currval / pbar.maxval * width)
         else:
           marked = ''