blob: bd7d5f61cf4512c946a0c4e224cde36b03b24a9f [file] [log] [blame]
Andrew M. Kuchlingd0939fa2000-06-10 23:06:53 +00001"""curses
2
3The main package for curses support for Python. Normally used by importing
4the package, and perhaps a particular module inside it.
5
6 import curses
7 from curses import textpad
8 curses.initwin()
9 ...
Tim Peters182b5ac2004-07-18 06:16:08 +000010
Andrew M. Kuchlingd0939fa2000-06-10 23:06:53 +000011"""
12
13__revision__ = "$Id$"
14
15from _curses import *
16from curses.wrapper import wrapper
Christian Heimes8640e742008-02-23 16:23:06 +000017import os as _os
Christian Heimes836baa52008-02-26 08:18:30 +000018import sys as _sys
Andrew M. Kuchlingd0939fa2000-06-10 23:06:53 +000019
Andrew M. Kuchling289d9d42000-06-26 23:54:03 +000020# Some constants, most notably the ACS_* ones, are only added to the C
21# _curses module's dictionary after initscr() is called. (Some
22# versions of SGI's curses don't define values for those constants
23# until initscr() has been called.) This wrapper function calls the
24# underlying C initscr(), and then copies the constants from the
25# _curses module to the curses package's dictionary. Don't do 'from
26# curses import *' if you'll be needing the ACS_* constants.
27
28def initscr():
29 import _curses, curses
Christian Heimes8640e742008-02-23 16:23:06 +000030 # we call setupterm() here because it raises an error
31 # instead of calling exit() in error cases.
Christian Heimes836baa52008-02-26 08:18:30 +000032 setupterm(term=_os.environ.get("TERM", "unknown"),
33 fd=_sys.__stdout__.fileno())
Andrew M. Kuchling289d9d42000-06-26 23:54:03 +000034 stdscr = _curses.initscr()
35 for key, value in _curses.__dict__.items():
36 if key[0:4] == 'ACS_' or key in ('LINES', 'COLS'):
37 setattr(curses, key, value)
Tim Peters182b5ac2004-07-18 06:16:08 +000038
Andrew M. Kuchling289d9d42000-06-26 23:54:03 +000039 return stdscr
Andrew M. Kuchlingd0939fa2000-06-10 23:06:53 +000040
Andrew M. Kuchling37f02632001-04-05 16:08:41 +000041# This is a similar wrapper for start_color(), which adds the COLORS and
42# COLOR_PAIRS variables which are only available after start_color() is
43# called.
Tim Peters182b5ac2004-07-18 06:16:08 +000044
Andrew M. Kuchling37f02632001-04-05 16:08:41 +000045def start_color():
46 import _curses, curses
47 retval = _curses.start_color()
48 if hasattr(_curses, 'COLORS'):
49 curses.COLORS = _curses.COLORS
50 if hasattr(_curses, 'COLOR_PAIRS'):
51 curses.COLOR_PAIRS = _curses.COLOR_PAIRS
Tim Peters182b5ac2004-07-18 06:16:08 +000052 return retval
Andrew M. Kuchling37f02632001-04-05 16:08:41 +000053
Andrew M. Kuchlingb45bd322000-08-01 01:21:11 +000054# Import Python has_key() implementation if _curses doesn't contain has_key()
55
56try:
57 has_key
58except NameError:
59 from has_key import has_key