Merge branch 'develop'

Adding kwargs to progress bar, so that bar chars can be customized

AUTHORS

@@ -14,3 +14,5 @@ Patches and Suggestions
 - Morgan Goose
 - Travis Swicegood
 - Will Thames
+- Greg Haskins
+- Miguel Araujo <maraujop>

HISTORY.rst

@@ -1,6 +1,13 @@
 History
 -------
 
+0.2.4
++++++
+
+* New eng module
+* Win32 Bugfix
+
+
 0.2.3
 +++++
 

clint/__init__.py

@@ -19,8 +19,8 @@ from .pipes import piped_in
 
 
 __title__ = 'clint'
-__version__ = '0.2.3'
-__build__ = 0x000203
+__version__ = '0.2.5'
+__build__ = 0x000205
 __author__ = 'Kenneth Reitz'
 __license__ = 'ISC'
 __copyright__ = 'Copyright 2011 Kenneth Reitz'

clint/arguments.py

@@ -13,33 +13,13 @@ from __future__ import absolute_import
 
 import os
 from sys import argv
-from glob import glob
 
 from .packages.ordereddict import OrderedDict
-from .utils import is_collection
-
-
+from .utils import expand_path, is_collection
 
 __all__ = ('Args', )
 
 
-
-def _expand_path(path):
-    """Expands directories and globs in given path."""
-
-    paths = []
-
-    if os.path.isdir(path):
-
-        for (dir, dirs, files) in os.walk(path):
-            for file in files:
-                paths.append(os.path.join(dir, file))
-    else:
-        paths.extend(glob(path))
-
-    return paths
-
-
 class Args(object):
     """CLI Argument management."""
 
@@ -110,20 +90,20 @@ class Args(object):
 
     def any_contain(self, x):
         """Tests if given string is contained in any stored argument."""
-        
+
         return bool(self.first_with(x))
 
 
     def contains(self, x):
-        """Tests if given object is in arguments list. 
+        """Tests if given object is in arguments list.
            Accepts strings and lists of strings."""
-        
+
         return self.__contains__(x)
 
 
     def first(self, x):
         """Returns first found index of given value (or list of values)"""
-        
+
         def _find( x):
             try:
                 return self.all.index(str(x))
@@ -212,7 +192,7 @@ class Args(object):
                         return False
             else:
                 return (x in self.all[index])
-        
+
         except IndexError:
             return False
 
@@ -221,7 +201,7 @@ class Args(object):
         """Returns true if argument exists at given index.
            Accepts: integer.
         """
-        
+
         try:
             self.all[x]
             return True
@@ -231,15 +211,15 @@ class Args(object):
 
     def value_after(self, x):
         """Returns value of argument after given found argument (or list thereof)."""
-        
+
         try:
             try:
                 i = self.all.index(x)
             except ValueError:
                 return None
-                
+
             return self.all[i + 1]
-            
+
         except IndexError:
             return None
 
@@ -266,21 +246,21 @@ class Args(object):
 
         return collection
 
-    
+
     @property
     def last(self):
         """Returns last argument."""
-        
+
         try:
             return self.all[-1]
         except IndexError:
             return None
 
-    
+
     @property
     def all(self):
         """Returns all arguments."""
-        
+
         return self._args
 
 
@@ -288,7 +268,7 @@ class Args(object):
         """Returns all arguments containing given string (or list thereof)"""
 
         _args = []
-        
+
         for arg in self.all:
             if is_collection(x):
                 for _x in x:
@@ -327,7 +307,7 @@ class Args(object):
         return self.start_with('-')
 
 
-    @property    
+    @property
     def not_flags(self):
         """Returns Arg object excluding flagged arguments."""
 
@@ -341,7 +321,7 @@ class Args(object):
         _paths = []
 
         for arg in self.all:
-            for path in _expand_path(arg):
+            for path in expand_path(arg):
                 if os.path.exists(path):
                     if absolute:
                         _paths.append(os.path.abspath(path))
@@ -358,7 +338,7 @@ class Args(object):
         _args = []
 
         for arg in self.all:
-            if not len(_expand_path(arg)):
+            if not len(expand_path(arg)):
                 if not os.path.exists(arg):
                     _args.append(arg)
 

clint/eng.py

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+
+"""
+clint.eng
+~~~~~~~~~
+
+This module provides English language string helpers.
+
+"""
+
+MORON_MODE = False
+COMMA = ','
+CONJUNCTION = 'and'
+SPACE = ' '
+
+
+def join(l, conj=CONJUNCTION, im_a_moron=MORON_MODE, seperator=COMMA):
+    """Joins lists of words. Oxford comma and all."""
+
+    collector = []
+    left = len(l)
+    seperator = seperator + SPACE
+    conj = conj + SPACE
+
+    for _l in l[:]:
+
+        left += -1
+
+        collector.append(_l)
+        if left == 1:
+            if len(l) == 2 or im_a_moron:
+                collector.append(SPACE)
+            else:
+                collector.append(seperator)
+
+            collector.append(conj)
+
+        elif left is not 0:
+            collector.append(seperator)
+
+    return unicode(str().join(collector))
+
+if __name__ == '__main__':
+    print join(['blue', 'red', 'yellow'], conj='or', im_a_moron=True)
+    print join(['blue', 'red', 'yellow'], conj='or')
+    print join(['blue', 'red'], conj='or')
+    print join(['blue', 'red'], conj='and')
+    print join(['blue'], conj='and')
+    print join(['blue', 'red', 'yellow', 'green', 'ello'], conj='and')

clint/packages/colorama/__init__.py

@@ -1,6 +1,6 @@
-from .initialise import init
+from .initialise import init, deinit, reinit
 from .ansi import Fore, Back, Style
 from .ansitowin32 import AnsiToWin32
 
-VERSION = '0.1.18'
+VERSION = '0.2.3'
 

clint/packages/colorama/ansitowin32.py

@@ -118,12 +118,12 @@ class AnsiToWin32(object):
             self.wrapped.flush()
         if self.autoreset:
             self.reset_all()
-        
+
 
     def reset_all(self):
         if self.convert:
             self.call_win32('m', (0,))
-        else:
+        elif is_a_tty(self.wrapped):
             self.wrapped.write(Style.RESET_ALL)
 
 
@@ -173,4 +173,10 @@ class AnsiToWin32(object):
                     args = func_args[1:]
                     kwargs = dict(on_stderr=self.on_stderr)
                     func(*args, **kwargs)
+        elif command in ('H', 'f'): # set cursor position
+            func = winterm.set_cursor_position
+            func(params, on_stderr=self.on_stderr)
+        elif command in ('J'):
+            func = winterm.erase_data
+            func(params, on_stderr=self.on_stderr)
 

clint/packages/colorama/initialise.py

@@ -7,6 +7,9 @@ from .ansitowin32 import AnsiToWin32
 orig_stdout = sys.stdout
 orig_stderr = sys.stderr
 
+wrapped_stdout = sys.stdout
+wrapped_stderr = sys.stderr
+
 atexit_done = False
 
 
@@ -16,11 +19,14 @@ def reset_all():
 
 def init(autoreset=False, convert=None, strip=None, wrap=True):
 
-    if wrap==False and (autoreset==True or convert==True or strip==True):
+    if not wrap and any([autoreset, convert, strip]):
         raise ValueError('wrap=False conflicts with any other arg=True')
 
-    sys.stdout = wrap_stream(orig_stdout, convert, strip, autoreset, wrap)
-    sys.stderr = wrap_stream(orig_stderr, convert, strip, autoreset, wrap)
+    global wrapped_stdout, wrapped_stderr
+    sys.stdout = wrapped_stdout = \
+        wrap_stream(orig_stdout, convert, strip, autoreset, wrap)
+    sys.stderr = wrapped_stderr = \
+        wrap_stream(orig_stderr, convert, strip, autoreset, wrap)
 
     global atexit_done
     if not atexit_done:
@@ -28,6 +34,16 @@ def init(autoreset=False, convert=None, strip=None, wrap=True):
         atexit_done = True
 
 
+def deinit():
+    sys.stdout = orig_stdout
+    sys.stderr = orig_stderr
+
+
+def reinit():
+    sys.stdout = wrapped_stdout
+    sys.stderr = wrapped_stdout
+
+
 def wrap_stream(stream, convert, strip, autoreset, wrap):
     if wrap:
         wrapper = AnsiToWin32(stream,
@@ -36,3 +52,4 @@ def wrap_stream(stream, convert, strip, autoreset, wrap):
             stream = wrapper.stream
     return stream
 
+

clint/packages/colorama/win32.py

@@ -48,8 +48,16 @@ else:
             ("srWindow", SMALL_RECT),
             ("dwMaximumWindowSize", COORD),
         ]
+        def __str__(self):
+            return '(%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d)' % (
+                self.dwSize.Y, self.dwSize.X
+                , self.dwCursorPosition.Y, self.dwCursorPosition.X
+                , self.wAttributes
+                , self.srWindow.Top, self.srWindow.Left, self.srWindow.Bottom, self.srWindow.Right
+                , self.dwMaximumWindowSize.Y, self.dwMaximumWindowSize.X
+            )
 
-    def GetConsoleScreenBufferInfo(stream_id):
+    def GetConsoleScreenBufferInfo(stream_id=STDOUT):
         handle = handles[stream_id]
         csbi = CONSOLE_SCREEN_BUFFER_INFO()
         success = windll.kernel32.GetConsoleScreenBufferInfo(
@@ -62,34 +70,54 @@ else:
 
     def SetConsoleTextAttribute(stream_id, attrs):
         handle = handles[stream_id]
-        success = windll.kernel32.SetConsoleTextAttribute(handle, attrs)
-        assert success
+        return windll.kernel32.SetConsoleTextAttribute(handle, attrs)
 
     def SetConsoleCursorPosition(stream_id, position):
-        handle = handles[stream_id]
         position = COORD(*position)
-        success = windll.kernel32.SetConsoleCursorPosition(handle, position)
-        assert success
+        # If the position is out of range, do nothing.
+        if position.Y <= 0 or position.X <= 0: 
+            return
+        # Adjust for Windows' SetConsoleCursorPosition:
+        #    1. being 0-based, while ANSI is 1-based.
+        #    2. expecting (x,y), while ANSI uses (y,x).
+        adjusted_position = COORD(position.Y - 1, position.X - 1)
+        # Adjust for viewport's scroll position
+        sr = GetConsoleScreenBufferInfo(STDOUT).srWindow
+        adjusted_position.Y += sr.Top
+        adjusted_position.X += sr.Left
+        # Resume normal processing
+        handle = handles[stream_id]
+        success = windll.kernel32.SetConsoleCursorPosition(handle, adjusted_position)
+        return success
 
     def FillConsoleOutputCharacter(stream_id, char, length, start):
         handle = handles[stream_id]
         char = TCHAR(char)
         length = DWORD(length)
-        start = COORD(*start)
         num_written = DWORD(0)
-        # AttributeError: function 'FillConsoleOutputCharacter' not found
-        # could it just be that my types are wrong?
-        success = windll.kernel32.FillConsoleOutputCharacter(
+        # Note that this is hard-coded for ANSI (vs wide) bytes.
+        success = windll.kernel32.FillConsoleOutputCharacterA(
             handle, char, length, start, byref(num_written))
-        assert success
         return num_written.value
 
+    def FillConsoleOutputAttribute(stream_id, attr, length, start):
+        ''' FillConsoleOutputAttribute( hConsole, csbi.wAttributes, dwConSize, coordScreen, &cCharsWritten )'''
+        handle = handles[stream_id]
+        attribute = WORD(attr)
+        length = DWORD(length)
+        num_written = DWORD(0)
+        # Note that this is hard-coded for ANSI (vs wide) bytes.
+        success = windll.kernel32.FillConsoleOutputAttribute(
+            handle, attribute, length, start, byref(num_written))
+        return success
+
 
 if __name__=='__main__':
     x = GetConsoleScreenBufferInfo(STDOUT)
-    print(x.dwSize)
-    print(x.dwCursorPosition)
-    print(x.wAttributes)
-    print(x.srWindow)
-    print(x.dwMaximumWindowSize)
+    print(x)
+    print('dwSize(height,width)                    = (%d,%d)' % (x.dwSize.Y, x.dwSize.X))
+    print('dwCursorPosition(y,x)                   = (%d,%d)' % (x.dwCursorPosition.Y, x.dwCursorPosition.X))
+    print('wAttributes(color)                      =  %d = 0x%02x' % (x.wAttributes, x.wAttributes))
+    print('srWindow(Top,Left)-(Bottom,Right)       = (%d,%d)-(%d,%d)' % (x.srWindow.Top, x.srWindow.Left, x.srWindow.Bottom, x.srWindow.Right))
+    print('dwMaximumWindowSize(maxHeight,maxWidth) = (%d,%d)' % (x.dwMaximumWindowSize.Y, x.dwMaximumWindowSize.X))
 

clint/packages/colorama/winterm.py

@@ -22,8 +22,7 @@ class WinStyle(object):
 class WinTerm(object):
 
     def __init__(self):
-        self._default = \
-            win32.GetConsoleScreenBufferInfo(win32.STDOUT).wAttributes
+        self._default = win32.GetConsoleScreenBufferInfo(win32.STDOUT).wAttributes
         self.set_attrs(self._default)
         self._default_fore = self._fore
         self._default_back = self._back
@@ -67,3 +66,37 @@ class WinTerm(object):
             handle = win32.STDERR
         win32.SetConsoleTextAttribute(handle, attrs)
 
+    def set_cursor_position(self, position=None, on_stderr=False):
+        if position is None:
+            #I'm not currently tracking the position, so there is no default.
+            #position = self.get_position()
+            return
+        handle = win32.STDOUT
+        if on_stderr:
+            handle = win32.STDERR
+        win32.SetConsoleCursorPosition(handle, position)
+
+    def erase_data(self, mode=0, on_stderr=False):
+        # 0 (or None) should clear from the cursor to the end of the screen.
+        # 1 should clear from the cursor to the beginning of the screen.
+        # 2 should clear the entire screen. (And maybe move cursor to (1,1)?)
+        #
+        # At the moment, I only support mode 2. From looking at the API, it 
+        #    should be possible to calculate a different number of bytes to clear, 
+        #    and to do so relative to the cursor position.
+        if mode[0] not in (2,):
+            return
+        handle = win32.STDOUT
+        if on_stderr:
+            handle = win32.STDERR
+        # here's where we'll home the cursor
+        coord_screen = win32.COORD(0,0) 
+        csbi = win32.GetConsoleScreenBufferInfo(handle)
+        # get the number of character cells in the current buffer
+        dw_con_size = csbi.dwSize.X * csbi.dwSize.Y
+        # fill the entire screen with blanks
+        win32.FillConsoleOutputCharacter(handle, ord(' '), dw_con_size, coord_screen)
+        # now set the buffer's attributes accordingly
+        win32.FillConsoleOutputAttribute(handle, self.get_attrs(), dw_con_size, coord_screen );
+        # put the cursor at (0, 0)
+        win32.SetConsoleCursorPosition(handle, (coord_screen.X, coord_screen.Y))

clint/textui/colored.py

@@ -27,6 +27,8 @@ DISABLE_COLOR = False
 
 if not sys.stdout.isatty():
     DISABLE_COLOR = True
+else:
+    colorama.init(autoreset=True)
 
 
 class ColoredString(object):
@@ -39,7 +41,6 @@ class ColoredString(object):
     @property
     def color_str(self):
         if sys.stdout.isatty() and not DISABLE_COLOR:
-            colorama.init(autoreset=True)
             return '%s%s%s' % (
                 getattr(colorama.Fore, self.color), self.s, colorama.Fore.RESET)
         else:

clint/textui/progress.py

@@ -15,20 +15,18 @@ import sys
 STREAM = sys.stderr
 
 BAR_TEMPLATE = '%s[%s%s] %i/%i\r'
-BAR_EMPTY_CHAR = '-'
-BAR_FILLED_CHAR = '='
 
 DOTS_CHAR = '.'
 
 
-def bar(it, label='', width=32, hide=False):
+def bar(it, label='', width=32, hide=False, empty_char='-', filled_char='='):
     """Progress iterator. Wrap your iterables with it."""
 
     def _show(_i):
         x = int(width*_i/count)
         if not hide:
             STREAM.write(BAR_TEMPLATE % (
-                label, BAR_FILLED_CHAR*x, BAR_EMPTY_CHAR*(width-x), _i, count))
+                label, bar_filled_char*x, bar_empty_char*(width-x), _i, count))
             STREAM.flush()
 
     count = len(it)

clint/utils.py

@@ -11,9 +11,29 @@ Various Python helpers used within clint.
 from __future__ import absolute_import
 from __future__ import with_statement
 
-import sys
 import errno
+import os.path
 from os import makedirs
+from glob import glob
+
+
+def expand_path(path):
+    """Expands directories and globs in given path."""
+
+    paths = []
+    path = os.path.expanduser(path)
+    path = os.path.expandvars(path)
+
+    if os.path.isdir(path):
+
+        for (dir, dirs, files) in os.walk(path):
+            for file in files:
+                paths.append(os.path.join(dir, file))
+    else:
+        paths.extend(glob(path))
+
+    return paths
+
 
 
 def is_collection(obj):
@@ -37,17 +57,17 @@ def mkdir_p(path):
 
 def tsplit(string, delimiters):
     """Behaves str.split but supports tuples of delimiters."""
-    
+
     delimiters = tuple(delimiters)
     stack = [string,]
-    
+
     for delimiter in delimiters:
         for i, substring in enumerate(stack):
             substack = substring.split(delimiter)
             stack.pop(i)
             for j, _substring in enumerate(substack):
                 stack.insert(i+j, _substring)
-            
+
     return stack
 
 def schunk(string, size):

examples/eng_join.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import sys
+import os
+
+sys.path.insert(0, os.path.abspath('..'))
+
+from clint.eng import join
+from clint.textui import colored, indent, puts
+
+colors = [
+    colored.blue('blue'),
+    colored.red('red'),
+    colored.yellow('yellow'),
+    colored.green('green'),
+    colored.magenta('magenta')
+]
+
+colors = map(str, colors)
+
+
+puts('Smart:')
+with indent(4):
+    for i in range(len(colors)):
+        puts(join(colors[:i+1]))
+puts('\n')
+puts('Stupid:')
+with indent(4):
+    for i in range(len(colors)):
+        puts(join(colors[:i+1], im_a_moron=True, conj='\'n'))