[Epydoc-commits] SF.net SVN: epydoc: [1714] trunk/epydoc/src/epydoc
Brought to you by:
edloper
Menu
▾
▴
[Epydoc-commits] SF.net SVN: epydoc: [1714] trunk/epydoc/src/epydoc
|
From: <ed...@us...> - 2008-02-02 06:32:01
|
Revision: 1714
http://epydoc.svn.sourceforge.net/epydoc/?rev=1714&view=rev
Author: edloper
Date: 2008-02-01 22:31:52 -0800 (Fri, 01 Feb 2008)
Log Message:
-----------
- Moved TerminalController to epydoc.util
- Added TerminalController.render
Modified Paths:
--------------
trunk/epydoc/src/epydoc/cli.py
trunk/epydoc/src/epydoc/util.py
Modified: trunk/epydoc/src/epydoc/cli.py
===================================================================
--- trunk/epydoc/src/epydoc/cli.py 2008-02-02 06:28:09 UTC (rev 1713)
+++ trunk/epydoc/src/epydoc/cli.py 2008-02-02 06:31:52 UTC (rev 1714)
@@ -70,7 +70,7 @@
import epydoc
from epydoc import log
from epydoc.util import wordwrap, run_subprocess, RunSubprocessError
-from epydoc.util import plaintext_to_html
+from epydoc.util import plaintext_to_html, TerminalController
from epydoc.apidoc import UNKNOWN
from epydoc.compat import *
import ConfigParser
@@ -1118,82 +1118,6 @@
######################################################################
# [xx] this should maybe move to util.py or log.py
-class TerminalController:
- """
- A class that can be used to portably generate formatted output to
- a terminal. See
- U{http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/475116}
- for documentation. (This is a somewhat stripped-down version.)
- """
- 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
- CLEAR_EOL = '' #: Clear to the end of the line.
- CLEAR_LINE = '' #: Clear the current line; cursor to BOL.
- BOLD = '' #: Turn on bold mode
- NORMAL = '' #: Turn off all modes
- COLS = 75 #: Width of the terminal (default to 75)
- BLACK = BLUE = GREEN = CYAN = RED = MAGENTA = YELLOW = WHITE = ''
-
- _STRING_CAPABILITIES = """
- BOL=cr UP=cuu1 DOWN=cud1 LEFT=cub1 RIGHT=cuf1
- CLEAR_EOL=el BOLD=bold UNDERLINE=smul NORMAL=sgr0""".split()
- _COLORS = """BLACK BLUE GREEN CYAN RED MAGENTA YELLOW WHITE""".split()
- _ANSICOLORS = "BLACK RED GREEN YELLOW BLUE MAGENTA CYAN WHITE".split()
-
- #: If this is set to true, then new TerminalControllers will
- #: assume that the terminal is not capable of doing manipulation
- #: of any kind.
- FORCE_SIMPLE_TERM = False
-
- def __init__(self, term_stream=sys.stdout):
- # If the stream isn't a tty, then assume it has no capabilities.
- if not term_stream.isatty(): return
- if self.FORCE_SIMPLE_TERM: return
-
- # Curses isn't available on all platforms
- try: import curses
- except:
- # If it's not available, then try faking enough to get a
- # simple progress bar.
- self.BOL = '\r'
- self.CLEAR_LINE = '\r' + ' '*self.COLS + '\r'
-
- # 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')
-
- # Look up string capabilities.
- for capability in self._STRING_CAPABILITIES:
- (attrib, cap_name) = capability.split('=')
- setattr(self, attrib, self._tigetstr(cap_name) or '')
- if self.BOL and self.CLEAR_EOL:
- self.CLEAR_LINE = self.BOL+self.CLEAR_EOL
-
- # 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 '')
-
- 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 re.sub(r'\$<\d+>[/*]?', '', cap)
-
class ConsoleLogger(log.Logger):
def __init__(self, verbosity, progress_mode=None):
self._verbosity = verbosity
Modified: trunk/epydoc/src/epydoc/util.py
===================================================================
--- trunk/epydoc/src/epydoc/util.py 2008-02-02 06:28:09 UTC (rev 1713)
+++ trunk/epydoc/src/epydoc/util.py 2008-02-02 06:31:52 UTC (rev 1714)
@@ -16,7 +16,7 @@
"""
__docformat__ = 'epytext en'
-import os, os.path, re
+import os, os.path, re, sys
######################################################################
## Python Source Types
@@ -287,3 +287,97 @@
return out, err
else:
raise RunSubprocessError(cmd, out, err)
+
+######################################################################
+## Terminal Control
+######################################################################
+
+class TerminalController:
+ """
+ A class that can be used to portably generate formatted output to
+ a terminal. See
+ U{http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/475116}
+ for documentation. (This is a somewhat stripped-down version.)
+ """
+ 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
+ CLEAR_EOL = '' #: Clear to the end of the line.
+ CLEAR_LINE = '' #: Clear the current line; cursor to BOL.
+ BOLD = '' #: Turn on bold mode
+ NORMAL = '' #: Turn off all modes
+ COLS = 75 #: Width of the terminal (default to 75)
+ BLACK = BLUE = GREEN = CYAN = RED = MAGENTA = YELLOW = WHITE = ''
+
+ _STRING_CAPABILITIES = """
+ BOL=cr UP=cuu1 DOWN=cud1 LEFT=cub1 RIGHT=cuf1
+ CLEAR_EOL=el BOLD=bold UNDERLINE=smul NORMAL=sgr0""".split()
+ _COLORS = """BLACK BLUE GREEN CYAN RED MAGENTA YELLOW WHITE""".split()
+ _ANSICOLORS = "BLACK RED GREEN YELLOW BLUE MAGENTA CYAN WHITE".split()
+
+ #: If this is set to true, then new TerminalControllers will
+ #: assume that the terminal is not capable of doing manipulation
+ #: of any kind.
+ FORCE_SIMPLE_TERM = False
+
+ def __init__(self, term_stream=sys.stdout):
+ # If the stream isn't a tty, then assume it has no capabilities.
+ if not term_stream.isatty(): return
+ if self.FORCE_SIMPLE_TERM: return
+
+ # Curses isn't available on all platforms
+ try: import curses
+ except:
+ # If it's not available, then try faking enough to get a
+ # simple progress bar.
+ self.BOL = '\r'
+ self.CLEAR_LINE = '\r' + ' '*self.COLS + '\r'
+
+ # 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')
+
+ # Look up string capabilities.
+ for capability in self._STRING_CAPABILITIES:
+ (attrib, cap_name) = capability.split('=')
+ setattr(self, attrib, self._tigetstr(cap_name) or '')
+ if self.BOL and self.CLEAR_EOL:
+ self.CLEAR_LINE = self.BOL+self.CLEAR_EOL
+
+ # 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 '')
+
+ 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 re.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 re.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])
+
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
