[Assorted-commits] SF.net SVN: assorted: [857] python-commons/trunk/src/commons
Brought to you by:
yangzhang
Menu
▾
▴
[Assorted-commits] SF.net SVN: assorted: [857] python-commons/trunk/src/commons
|
From: <yan...@us...> - 2008-06-30 02:58:38
|
Revision: 857
http://assorted.svn.sourceforge.net/assorted/?rev=857&view=rev
Author: yangzhang
Date: 2008-06-29 19:58:41 -0700 (Sun, 29 Jun 2008)
Log Message:
-----------
added run(); added TerminalController; renamed free_struct; added repr, eq for free_struct
Modified Paths:
--------------
python-commons/trunk/src/commons/misc.py
python-commons/trunk/src/commons/structs.py
Modified: python-commons/trunk/src/commons/misc.py
===================================================================
--- python-commons/trunk/src/commons/misc.py 2008-06-30 02:54:06 UTC (rev 856)
+++ python-commons/trunk/src/commons/misc.py 2008-06-30 02:58:41 UTC (rev 857)
@@ -1,13 +1,18 @@
# -*- mode: python; tab-width: 4; indent-tabs-mode: nil; py-indent-offset: 4; -*-
# vim:ft=python:et:sw=4:ts=4
-from contextlib import *
-from time import *
-
"""
Miscellanea.
"""
+from contextlib import *
+from subprocess import CalledProcessError, PIPE, Popen
+from time import *
+
+# TerminalController
+from sys import stdout
+from re import sub
+
def generate_bit_fields(count):
"""
A generator of [2^i] for i from 0 to (count - 1). Useful for,
@@ -60,3 +65,162 @@
"""
f()
return g()
+
+def run(cmd):
+ """
+ Run the given command (a list of program and argument strings) and return the
+ stdout as a string, raising a L{CalledProcessError} if the program exited
+ with a non-zero status.
+ """
+ p = Popen(cmd, stdout=PIPE)
+ stdout = p.communicate()[0]
+ if p.returncode != 0: raise CalledProcessError(p.returncode, cmd)
+ return stdout
+
+class TerminalController:
+ """
+ From U{http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/475116}.
+
+ A class that can be used to portably generate formatted output to
+ a terminal.
+
+ `TerminalController` defines a set of instance variables whose
+ values are initialized to the control sequence necessary to
+ perform a given action. These can be simply included in normal
+ output to the terminal:
+
+ >>> term = TerminalController()
+ >>> print 'This is '+term.GREEN+'green'+term.NORMAL
+
+ Alternatively, the `render()` method can used, which replaces
+ '${action}' with the string required to perform 'action':
+
+ >>> term = TerminalController()
+ >>> print term.render('This is ${GREEN}green${NORMAL}')
+
+ If the terminal doesn't support a given action, then the value of
+ the corresponding instance variable will be set to ''. As a
+ result, the above code will still work on terminals that do not
+ support color, except that their output will not be colored.
+ Also, this means that you can test whether the terminal supports a
+ given action by simply testing the truth value of the
+ corresponding instance variable:
+
+ >>> term = TerminalController()
+ >>> if term.CLEAR_SCREEN:
+ ... print 'This terminal supports clearning the screen.'
+
+ Finally, if the width and height of the terminal are known, then
+ they will be stored in the `COLS` and `LINES` attributes.
+ """
+ # Cursor movement:
+ BOL = '' #: Move the cursor to the beginning of the line
+ UP = '' #: Move the cursor up one line
+ DOWN = '' #: Move the cursor down one line
+ LEFT = '' #: Move the cursor left one char
+ RIGHT = '' #: Move the cursor right one char
+
+ # Deletion:
+ CLEAR_SCREEN = '' #: Clear the screen and move to home position
+ CLEAR_EOL = '' #: Clear to the end of the line.
+ CLEAR_BOL = '' #: Clear to the beginning of the line.
+ CLEAR_EOS = '' #: Clear to the end of the screen
+
+ # Output modes:
+ BOLD = '' #: Turn on bold mode
+ BLINK = '' #: Turn on blink mode
+ DIM = '' #: Turn on half-bright mode
+ REVERSE = '' #: Turn on reverse-video mode
+ NORMAL = '' #: Turn off all modes
+
+ # Cursor display:
+ HIDE_CURSOR = '' #: Make the cursor invisible
+ SHOW_CURSOR = '' #: Make the cursor visible
+
+ # Terminal size:
+ COLS = None #: Width of the terminal (None for unknown)
+ LINES = None #: Height of the terminal (None for unknown)
+
+ # Foreground colors:
+ BLACK = BLUE = GREEN = CYAN = RED = MAGENTA = YELLOW = WHITE = ''
+
+ # Background colors:
+ BG_BLACK = BG_BLUE = BG_GREEN = BG_CYAN = ''
+ BG_RED = BG_MAGENTA = BG_YELLOW = BG_WHITE = ''
+
+ _STRING_CAPABILITIES = """
+ BOL=cr UP=cuu1 DOWN=cud1 LEFT=cub1 RIGHT=cuf1
+ CLEAR_SCREEN=clear CLEAR_EOL=el CLEAR_BOL=el1 CLEAR_EOS=ed BOLD=bold
+ BLINK=blink DIM=dim REVERSE=rev UNDERLINE=smul NORMAL=sgr0
+ HIDE_CURSOR=cinvis SHOW_CURSOR=cnorm""".split()
+ _COLORS = """BLACK BLUE GREEN CYAN RED MAGENTA YELLOW WHITE""".split()
+ _ANSICOLORS = "BLACK RED GREEN YELLOW BLUE MAGENTA CYAN WHITE".split()
+
+ def __init__(self, term_stream=stdout):
+ """
+ Create a `TerminalController` and initialize its attributes
+ with appropriate values for the current terminal.
+ `term_stream` is the stream that will be used for terminal
+ output; if this stream is not a tty, then the terminal is
+ assumed to be a dumb terminal (i.e., have no capabilities).
+ """
+ # Curses isn't available on all platforms
+ try: import curses
+ except: return
+
+ # If the stream isn't a tty, then assume it has no capabilities.
+ if not term_stream.isatty(): return
+
+ # Check the terminal type. If we fail, then assume that the
+ # terminal has no capabilities.
+ try: curses.setupterm()
+ except: return
+
+ # Look up numeric capabilities.
+ self.COLS = curses.tigetnum('cols')
+ self.LINES = curses.tigetnum('lines')
+
+ # Look up string capabilities.
+ for capability in self._STRING_CAPABILITIES:
+ (attrib, cap_name) = capability.split('=')
+ setattr(self, attrib, self._tigetstr(cap_name) or '')
+
+ # Colors
+ set_fg = self._tigetstr('setf')
+ if set_fg:
+ for i,color in zip(range(len(self._COLORS)), self._COLORS):
+ setattr(self, color, curses.tparm(set_fg, i) or '')
+ set_fg_ansi = self._tigetstr('setaf')
+ if set_fg_ansi:
+ for i,color in zip(range(len(self._ANSICOLORS)), self._ANSICOLORS):
+ setattr(self, color, curses.tparm(set_fg_ansi, i) or '')
+ set_bg = self._tigetstr('setb')
+ if set_bg:
+ for i,color in zip(range(len(self._COLORS)), self._COLORS):
+ setattr(self, 'BG_'+color, curses.tparm(set_bg, i) or '')
+ set_bg_ansi = self._tigetstr('setab')
+ if set_bg_ansi:
+ for i,color in zip(range(len(self._ANSICOLORS)), self._ANSICOLORS):
+ setattr(self, 'BG_'+color, curses.tparm(set_bg_ansi, i) or '')
+
+ def _tigetstr(self, cap_name):
+ # String capabilities can include "delays" of the form "$<2>".
+ # For any modern terminal, we should be able to just ignore
+ # these, so strip them out.
+ import curses
+ cap = curses.tigetstr(cap_name) or ''
+ return sub(r'\$<\d+>[/*]?', '', cap)
+
+ def render(self, template):
+ """
+ Replace each $-substitutions in the given template string with
+ the corresponding terminal control string (if it's defined) or
+ '' (if it's not).
+ """
+ return sub(r'\$\$|\${\w+}', self._render_sub, template)
+
+ def _render_sub(self, match):
+ s = match.group()
+ if s == '$$': return s
+ else: return getattr(self, s[2:-1])
+
Modified: python-commons/trunk/src/commons/structs.py
===================================================================
--- python-commons/trunk/src/commons/structs.py 2008-06-30 02:54:06 UTC (rev 856)
+++ python-commons/trunk/src/commons/structs.py 2008-06-30 02:58:41 UTC (rev 857)
@@ -40,12 +40,19 @@
def __delitem__( self, k ):
return dict.__delitem__( self, k.lower() )
-class FreeStruct( object ):
+class free_struct( object ):
"""
General-purpose namespace structure.
"""
def __init__( self, **args ):
self.__dict__.update( args )
+ def __repr__( self ):
+ fields = ( '%s = %r' % ( name, value )
+ for name, value in self.__dict__.iteritems() )
+ return "%s(%s)" % ( self.__class__.__name__, ', '.join( fields ) )
+ def __eq__( self, other ):
+ return type( self ) == type( other ) and \
+ self.__dict__ == other.__dict__
class LazyObject( object ):
"""
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
