Commit 566c3825 authored by maruel@chromium.org's avatar maruel@chromium.org

Update colorama from upstream to 5a3100113a3a.

This fixes license headers.

Interestingly, the pylint workaround at r133705 doesn't seem to be necessary
anymore.

R=stip@chromium.org
BUG=

Review URL: https://codereview.chromium.org/54603003

git-svn-id: svn://svn.chromium.org/chrome/trunk/tools/depot_tools@232152 0039d316-1c4b-4281-b951-d872f2087c98
parent 7b6847f4
Copyright (c) 2010 Jonathan Hartley <tartley@tartley.com> Copyright (c) 2010 Jonathan Hartley
Released under the New BSD license (reproduced below), or alternatively you may
use this software under any OSI approved open source license such as those at
http://opensource.org/licenses/alphabetical
All rights reserved. All rights reserved.
Redistribution and use in source and binary forms, with or without Redistribution and use in source and binary forms, with or without
...@@ -16,7 +11,7 @@ modification, are permitted provided that the following conditions are met: ...@@ -16,7 +11,7 @@ modification, are permitted provided that the following conditions are met:
this list of conditions and the following disclaimer in the documentation this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution. and/or other materials provided with the distribution.
* Neither the name(s) of the copyright holders, nor those of its contributors * Neither the name of the copyright holders, nor those of its contributors
may be used to endorse or promote products derived from this software without may be used to endorse or promote products derived from this software without
specific prior written permission. specific prior written permission.
......
Name: colorama Name: colorama
URL: http://code.google.com/p/colorama URL: http://code.google.com/p/colorama
Version: 2.3 + c25659277b30 Version: 5a3100113a3a (0.2.7)
Revision: c25659277b30 Revision: 5a3100113a3a
Description: Description:
Provides a simple cross-platform API to print colored terminal text from Python Provides a simple cross-platform API to print colored terminal text from Python
applications. applications.
LICENSE.txt is the license file copied from upstream. Additional changes:
- Kept colorama/ but removed colorama/tests/.
- Copied LICENSE.txt and README.txt.
- Converted all the files to LF EOL style.
...@@ -2,17 +2,24 @@ Download and docs: ...@@ -2,17 +2,24 @@ Download and docs:
http://pypi.python.org/pypi/colorama http://pypi.python.org/pypi/colorama
Development: Development:
http://code.google.com/p/colorama http://code.google.com/p/colorama
Discussion group:
https://groups.google.com/forum/#!forum/python-colorama
Description Description
=========== ===========
Makes ANSI escape character sequences, for producing colored terminal text and Makes ANSI escape character sequences for producing colored terminal text and
cursor positioning, work under MS Windows. cursor positioning work under MS Windows.
ANSI escape character sequences have long been used to produce colored terminal ANSI escape character sequences have long been used to produce colored terminal
text and cursor positioning on Unix and Macs. Colorama makes this work on text and cursor positioning on Unix and Macs. Colorama makes this work on
Windows, too. It also provides some shortcuts to help generate ANSI sequences, Windows, too, by wrapping stdout, stripping ANSI sequences it finds (which
and works fine in conjunction with any other ANSI sequence generation library, otherwise show up as gobbledygook in your output), and converting them into the
appropriate win32 calls to modify the state of the terminal. On other platforms,
Colorama does nothing.
Colorama also provides some shortcuts to help generate ANSI sequences
but works fine in conjunction with any other ANSI sequence generation library,
such as Termcolor (http://pypi.python.org/pypi/termcolor.) such as Termcolor (http://pypi.python.org/pypi/termcolor.)
This has the upshot of providing a simple cross-platform API for printing This has the upshot of providing a simple cross-platform API for printing
...@@ -21,6 +28,11 @@ applications or libraries which use ANSI sequences to produce colored output on ...@@ -21,6 +28,11 @@ applications or libraries which use ANSI sequences to produce colored output on
Linux or Macs can now also work on Windows, simply by calling Linux or Macs can now also work on Windows, simply by calling
``colorama.init()``. ``colorama.init()``.
An alternative approach is to install 'ansi.sys' on Windows machines, which
provides the same behaviour for all applications running in terminals. Colorama
is intended for situations where that isn't easy (e.g. maybe your app doesn't
have an installer.)
Demo scripts in the source code repository prints some colored text using Demo scripts in the source code repository prints some colored text using
ANSI sequences. Compare their output under Gnome-terminal's built in ANSI ANSI sequences. Compare their output under Gnome-terminal's built in ANSI
handling, versus on Windows Command-Prompt using Colorama: handling, versus on Windows Command-Prompt using Colorama:
...@@ -39,12 +51,17 @@ These screengrabs show that Colorama on Windows does not support ANSI 'dim ...@@ -39,12 +51,17 @@ These screengrabs show that Colorama on Windows does not support ANSI 'dim
text': it looks the same as 'normal text'. text': it looks the same as 'normal text'.
License
=======
Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.
Dependencies Dependencies
============ ============
None, other than Python. Tested on Python 2.5.5, 2.6.5, 2.7, 3.1.2, and 3.2 None, other than Python. Tested on Python 2.5.5, 2.6.5, 2.7, 3.1.2, and 3.2
Usage Usage
===== =====
...@@ -79,16 +96,16 @@ Cross-platform printing of colored text can then be done using Colorama's ...@@ -79,16 +96,16 @@ Cross-platform printing of colored text can then be done using Colorama's
constant shorthand for ANSI escape sequences:: constant shorthand for ANSI escape sequences::
from colorama import Fore, Back, Style from colorama import Fore, Back, Style
print Fore.RED + 'some red text' print(Fore.RED + 'some red text')
print Back.GREEN + and with a green background' print(Back.GREEN + 'and with a green background')
print Style.DIM + 'and in dim text' print(Style.DIM + 'and in dim text')
print + Fore.RESET + Back.RESET + Style.RESET_ALL print(Fore.RESET + Back.RESET + Style.RESET_ALL)
print 'back to normal now' print('back to normal now')
or simply by manually printing ANSI sequences from your own code:: or simply by manually printing ANSI sequences from your own code::
print '/033[31m' + 'some red text' print('/033[31m' + 'some red text')
print '/033[30m' # and reset to default color print('/033[30m' # and reset to default color)
or Colorama can be used happily in conjunction with existing ANSI libraries or Colorama can be used happily in conjunction with existing ANSI libraries
such as Termcolor:: such as Termcolor::
...@@ -100,7 +117,7 @@ such as Termcolor:: ...@@ -100,7 +117,7 @@ such as Termcolor::
init() init()
# then use Termcolor for all colored text output # then use Termcolor for all colored text output
print colored('Hello, World!', 'green', 'on_red') print(colored('Hello, World!', 'green', 'on_red'))
Available formatting constants are:: Available formatting constants are::
...@@ -131,8 +148,8 @@ init(autoreset=False): ...@@ -131,8 +148,8 @@ init(autoreset=False):
from colorama import init from colorama import init
init(autoreset=True) init(autoreset=True)
print Fore.RED + 'some red text' print(Fore.RED + 'some red text')
print 'automatically back to default color again' print('automatically back to default color again')
init(strip=None): init(strip=None):
Pass ``True`` or ``False`` to override whether ansi codes should be Pass ``True`` or ``False`` to override whether ansi codes should be
...@@ -154,24 +171,34 @@ init(wrap=True): ...@@ -154,24 +171,34 @@ init(wrap=True):
continue to work as normal. To do cross-platform colored output, you can continue to work as normal. To do cross-platform colored output, you can
use Colorama's ``AnsiToWin32`` proxy directly:: use Colorama's ``AnsiToWin32`` proxy directly::
import sys
from colorama import init, AnsiToWin32 from colorama import init, AnsiToWin32
init(wrap=False) init(wrap=False)
stream = AnsiToWin32(sys.stderr).stream stream = AnsiToWin32(sys.stderr).stream
print >>stream, Fore.BLUE + 'blue text on stderr'
# Python 2
print >>stream, Fore.BLUE + 'blue text on stderr'
# Python 3
print(Fore.BLUE + 'blue text on stderr', file=stream)
Status & Known Problems Status & Known Problems
======================= =======================
I've personally only tested it on WinXP (CMD, Console2) and Ubuntu I've personally only tested it on WinXP (CMD, Console2), Ubuntu
(gnome-terminal, xterm), although it sounds like others are using it on other (gnome-terminal, xterm), and OSX.
platforms too.
Some presumably valid ANSI sequences aren't recognised (see details below)
but to my knowledge nobody has yet complained about this. Puzzling.
See outstanding issues and wishlist at: See outstanding issues and wishlist at:
http://code.google.com/p/colorama/issues/list http://code.google.com/p/colorama/issues/list
If anything doesn't work for you, or doesn't do what you expected or hoped for, If anything doesn't work for you, or doesn't do what you expected or hoped for,
I'd *love* to hear about it on that issues list. I'd love to hear about it on that issues list, would be delighted by patches,
and would be happy to grant commit access to anyone who submits a working patch
or two.
Recognised ANSI Sequences Recognised ANSI Sequences
...@@ -181,7 +208,7 @@ ANSI sequences generally take the form: ...@@ -181,7 +208,7 @@ ANSI sequences generally take the form:
ESC [ <param> ; <param> ... <command> ESC [ <param> ; <param> ... <command>
Where <param> is an integer, and <command> is a single letter. Zero or more Where <param> is an integer, and <command> is a single letter. Zero or more
params are passed to a <command>. If no params are passed, it is generally params are passed to a <command>. If no params are passed, it is generally
synonymous with passing a single zero. No spaces exist in the sequence, they synonymous with passing a single zero. No spaces exist in the sequence, they
have just been inserted here to make it easy to read. have just been inserted here to make it easy to read.
...@@ -216,7 +243,7 @@ The only ANSI sequences that colorama converts into win32 calls are:: ...@@ -216,7 +243,7 @@ The only ANSI sequences that colorama converts into win32 calls are::
ESC [ 49 m # reset ESC [ 49 m # reset
# cursor positioning # cursor positioning
ESC [ x;y H # position cursor at x,y ESC [ y;x H # position cursor at x across, y down
# clear the screen # clear the screen
ESC [ mode J # clear the screen. Only mode 2 (clear entire screen) ESC [ mode J # clear the screen. Only mode 2 (clear entire screen)
...@@ -240,6 +267,8 @@ google code. ...@@ -240,6 +267,8 @@ google code.
Development Development
=========== ===========
Help and fixes welcome! Ask Jonathan for commit rights, you'll get them.
Running tests requires: Running tests requires:
- Michael Foord's 'mock' module to be installed. - Michael Foord's 'mock' module to be installed.
...@@ -255,10 +284,21 @@ The -s is required because 'nosetests' otherwise applies a proxy of its own to ...@@ -255,10 +284,21 @@ The -s is required because 'nosetests' otherwise applies a proxy of its own to
stdout, which confuses the unit tests. stdout, which confuses the unit tests.
Contact
=======
Created by Jonathan Hartley, tartley@tartley.com
Thanks Thanks
====== ======
Daniel Griffith for multiple fabulous patches. | Ben Hoyt, for a magnificent fix under 64-bit Windows.
Oscar Lesta for valuable fix to stop ANSI chars being sent to non-tty output. | Jesse@EmptySquare for submitting a fix for examples in the README.
Roger Binns, for many suggestions, valuable feedback, & bug reports. | User 'jamessp', an observant documentation fix for cursor positioning.
Tim Golden for thought and much appreciated feedback on the initial idea. | User 'vaal1239', Dave Mckee & Lackner Kristof for a tiny but much-needed Win7 fix.
| Julien Stuyck, for wisely suggesting Python3 compatible updates to README.
| Daniel Griffith for multiple fabulous patches.
| Oscar Lesta for valuable fix to stop ANSI chars being sent to non-tty output.
| Roger Binns, for many suggestions, valuable feedback, & bug reports.
| Tim Golden for thought and much appreciated feedback on the initial idea.
# Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.
from .initialise import init, deinit, reinit from .initialise import init, deinit, reinit
from .ansi import Fore, Back, Style from .ansi import Fore, Back, Style
from .ansitowin32 import AnsiToWin32 from .ansitowin32 import AnsiToWin32
VERSION = '0.2.4' VERSION = '0.2.7'
# Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.
''' '''
This module generates ANSI character codes to printing colors to terminals. This module generates ANSI character codes to printing colors to terminals.
See: http://en.wikipedia.org/wiki/ANSI_escape_code See: http://en.wikipedia.org/wiki/ANSI_escape_code
...@@ -9,14 +10,13 @@ def code_to_chars(code): ...@@ -9,14 +10,13 @@ def code_to_chars(code):
return CSI + str(code) + 'm' return CSI + str(code) + 'm'
class AnsiCodes(object): class AnsiCodes(object):
def __init__(self): def __init__(self, codes):
for name in dir(self): for name in dir(codes):
if not name.startswith('_') and name.upper() == name: if not name.startswith('_'):
value = getattr(self, name) value = getattr(codes, name)
setattr(self, name, code_to_chars(value)) setattr(self, name, code_to_chars(value))
class AnsiFore:
class AnsiFore(AnsiCodes):
BLACK = 30 BLACK = 30
RED = 31 RED = 31
GREEN = 32 GREEN = 32
...@@ -27,7 +27,7 @@ class AnsiFore(AnsiCodes): ...@@ -27,7 +27,7 @@ class AnsiFore(AnsiCodes):
WHITE = 37 WHITE = 37
RESET = 39 RESET = 39
class AnsiBack(AnsiCodes): class AnsiBack:
BLACK = 40 BLACK = 40
RED = 41 RED = 41
GREEN = 42 GREEN = 42
...@@ -38,15 +38,13 @@ class AnsiBack(AnsiCodes): ...@@ -38,15 +38,13 @@ class AnsiBack(AnsiCodes):
WHITE = 47 WHITE = 47
RESET = 49 RESET = 49
class AnsiStyle(AnsiCodes): class AnsiStyle:
BRIGHT = 1 BRIGHT = 1
DIM = 2 DIM = 2
NORMAL = 22 NORMAL = 22
RESET_ALL = 0 RESET_ALL = 0
Fore = AnsiCodes( AnsiFore )
Back = AnsiCodes( AnsiBack )
Style = AnsiCodes( AnsiStyle )
# Constructing the object converts the code into the equivalent ANSI escape
# string.
Fore = AnsiFore()
Back = AnsiBack()
Style = AnsiStyle()
# Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.
import re import re
import sys import sys
......
# Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.
import atexit import atexit
import sys import sys
......
# Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.
# from winbase.h # from winbase.h
STDOUT = -11 STDOUT = -11
...@@ -5,48 +6,23 @@ STDERR = -12 ...@@ -5,48 +6,23 @@ STDERR = -12
try: try:
from ctypes import windll from ctypes import windll
from ctypes import wintypes
except ImportError: except ImportError:
windll = None windll = None
SetConsoleTextAttribute = lambda *_: None SetConsoleTextAttribute = lambda *_: None
else: else:
from ctypes import ( from ctypes import (
byref, Structure, c_char, c_short, c_uint32, c_ushort byref, Structure, c_char, c_short, c_uint32, c_ushort, POINTER
) )
handles = {
STDOUT: windll.kernel32.GetStdHandle(STDOUT),
STDERR: windll.kernel32.GetStdHandle(STDERR),
}
SHORT = c_short
WORD = c_ushort
DWORD = c_uint32
TCHAR = c_char
class COORD(Structure):
"""struct in wincon.h"""
_fields_ = [
('X', SHORT),
('Y', SHORT),
]
class SMALL_RECT(Structure):
"""struct in wincon.h."""
_fields_ = [
("Left", SHORT),
("Top", SHORT),
("Right", SHORT),
("Bottom", SHORT),
]
class CONSOLE_SCREEN_BUFFER_INFO(Structure): class CONSOLE_SCREEN_BUFFER_INFO(Structure):
"""struct in wincon.h.""" """struct in wincon.h."""
_fields_ = [ _fields_ = [
("dwSize", COORD), ("dwSize", wintypes._COORD),
("dwCursorPosition", COORD), ("dwCursorPosition", wintypes._COORD),
("wAttributes", WORD), ("wAttributes", wintypes.WORD),
("srWindow", SMALL_RECT), ("srWindow", wintypes.SMALL_RECT),
("dwMaximumWindowSize", COORD), ("dwMaximumWindowSize", wintypes._COORD),
] ]
def __str__(self): def __str__(self):
return '(%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d)' % ( return '(%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d)' % (
...@@ -57,53 +33,102 @@ else: ...@@ -57,53 +33,102 @@ else:
, self.dwMaximumWindowSize.Y, self.dwMaximumWindowSize.X , self.dwMaximumWindowSize.Y, self.dwMaximumWindowSize.X
) )
_GetStdHandle = windll.kernel32.GetStdHandle
_GetStdHandle.argtypes = [
wintypes.DWORD,
]
_GetStdHandle.restype = wintypes.HANDLE
_GetConsoleScreenBufferInfo = windll.kernel32.GetConsoleScreenBufferInfo
_GetConsoleScreenBufferInfo.argtypes = [
wintypes.HANDLE,
POINTER(CONSOLE_SCREEN_BUFFER_INFO),
]
_GetConsoleScreenBufferInfo.restype = wintypes.BOOL
_SetConsoleTextAttribute = windll.kernel32.SetConsoleTextAttribute
_SetConsoleTextAttribute.argtypes = [
wintypes.HANDLE,
wintypes.WORD,
]
_SetConsoleTextAttribute.restype = wintypes.BOOL
_SetConsoleCursorPosition = windll.kernel32.SetConsoleCursorPosition
_SetConsoleCursorPosition.argtypes = [
wintypes.HANDLE,
wintypes._COORD,
]
_SetConsoleCursorPosition.restype = wintypes.BOOL
_FillConsoleOutputCharacterA = windll.kernel32.FillConsoleOutputCharacterA
_FillConsoleOutputCharacterA.argtypes = [
wintypes.HANDLE,
c_char,
wintypes.DWORD,
wintypes._COORD,
POINTER(wintypes.DWORD),
]
_FillConsoleOutputCharacterA.restype = wintypes.BOOL
_FillConsoleOutputAttribute = windll.kernel32.FillConsoleOutputAttribute
_FillConsoleOutputAttribute.argtypes = [
wintypes.HANDLE,
wintypes.WORD,
wintypes.DWORD,
wintypes._COORD,
POINTER(wintypes.DWORD),
]
_FillConsoleOutputAttribute.restype = wintypes.BOOL
handles = {
STDOUT: _GetStdHandle(STDOUT),
STDERR: _GetStdHandle(STDERR),
}
def GetConsoleScreenBufferInfo(stream_id=STDOUT): def GetConsoleScreenBufferInfo(stream_id=STDOUT):
handle = handles[stream_id] handle = handles[stream_id]
csbi = CONSOLE_SCREEN_BUFFER_INFO() csbi = CONSOLE_SCREEN_BUFFER_INFO()
success = windll.kernel32.GetConsoleScreenBufferInfo( success = _GetConsoleScreenBufferInfo(
handle, byref(csbi)) handle, byref(csbi))
return csbi return csbi
def SetConsoleTextAttribute(stream_id, attrs): def SetConsoleTextAttribute(stream_id, attrs):
handle = handles[stream_id] handle = handles[stream_id]
return windll.kernel32.SetConsoleTextAttribute(handle, attrs) return _SetConsoleTextAttribute(handle, attrs)
def SetConsoleCursorPosition(stream_id, position): def SetConsoleCursorPosition(stream_id, position):
position = COORD(*position) position = wintypes._COORD(*position)
# If the position is out of range, do nothing. # If the position is out of range, do nothing.
if position.Y <= 0 or position.X <= 0: if position.Y <= 0 or position.X <= 0:
return return
# Adjust for Windows' SetConsoleCursorPosition: # Adjust for Windows' SetConsoleCursorPosition:
# 1. being 0-based, while ANSI is 1-based. # 1. being 0-based, while ANSI is 1-based.
# 2. expecting (x,y), while ANSI uses (y,x). # 2. expecting (x,y), while ANSI uses (y,x).
adjusted_position = COORD(position.Y - 1, position.X - 1) adjusted_position = wintypes._COORD(position.Y - 1, position.X - 1)
# Adjust for viewport's scroll position # Adjust for viewport's scroll position
sr = GetConsoleScreenBufferInfo(STDOUT).srWindow sr = GetConsoleScreenBufferInfo(STDOUT).srWindow
adjusted_position.Y += sr.Top adjusted_position.Y += sr.Top
adjusted_position.X += sr.Left adjusted_position.X += sr.Left
# Resume normal processing # Resume normal processing
handle = handles[stream_id] handle = handles[stream_id]
return windll.kernel32.SetConsoleCursorPosition(handle, adjusted_position) return _SetConsoleCursorPosition(handle, adjusted_position)
def FillConsoleOutputCharacter(stream_id, char, length, start): def FillConsoleOutputCharacter(stream_id, char, length, start):
handle = handles[stream_id] handle = handles[stream_id]
char = TCHAR(char) char = c_char(char)
length = DWORD(length) length = wintypes.DWORD(length)
num_written = DWORD(0) num_written = wintypes.DWORD(0)
# Note that this is hard-coded for ANSI (vs wide) bytes. # Note that this is hard-coded for ANSI (vs wide) bytes.
success = windll.kernel32.FillConsoleOutputCharacterA( success = _FillConsoleOutputCharacterA(
handle, char, length, start, byref(num_written)) handle, char, length, start, byref(num_written))
return num_written.value return num_written.value
def FillConsoleOutputAttribute(stream_id, attr, length, start): def FillConsoleOutputAttribute(stream_id, attr, length, start):
''' FillConsoleOutputAttribute( hConsole, csbi.wAttributes, dwConSize, coordScreen, &cCharsWritten )''' ''' FillConsoleOutputAttribute( hConsole, csbi.wAttributes, dwConSize, coordScreen, &cCharsWritten )'''
handle = handles[stream_id] handle = handles[stream_id]
attribute = WORD(attr) attribute = wintypes.WORD(attr)
length = DWORD(length) length = wintypes.DWORD(length)
num_written = DWORD(0) num_written = wintypes.DWORD(0)
# Note that this is hard-coded for ANSI (vs wide) bytes. # Note that this is hard-coded for ANSI (vs wide) bytes.
return windll.kernel32.FillConsoleOutputAttribute( return _FillConsoleOutputAttribute(
handle, attribute, length, start, byref(num_written)) handle, attribute, length, start, byref(num_written))
# Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.
from . import win32 from . import win32
...@@ -113,7 +113,7 @@ class WinTerm(object): ...@@ -113,7 +113,7 @@ class WinTerm(object):
# get the number of character cells in the current buffer # get the number of character cells in the current buffer
dw_con_size = csbi.dwSize.X * csbi.dwSize.Y dw_con_size = csbi.dwSize.X * csbi.dwSize.Y
# fill the entire screen with blanks # fill the entire screen with blanks
win32.FillConsoleOutputCharacter(handle, ord(' '), dw_con_size, coord_screen) win32.FillConsoleOutputCharacter(handle, ' ', dw_con_size, coord_screen)
# now set the buffer's attributes accordingly # now set the buffer's attributes accordingly
win32.FillConsoleOutputAttribute(handle, self.get_attrs(), dw_con_size, coord_screen ); win32.FillConsoleOutputAttribute(handle, self.get_attrs(), dw_con_size, coord_screen );
# put the cursor at (0, 0) # put the cursor at (0, 0)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment