File: excolors.py

package info (click to toggle)
ipython 8.35.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 11,696 kB
  • sloc: python: 42,461; sh: 376; makefile: 243
file content (192 lines) | stat: -rw-r--r-- 6,527 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# -*- coding: utf-8 -*-
"""
Color schemes for exception handling code in IPython.
"""

import os

#*****************************************************************************
#       Copyright (C) 2005-2006 Fernando Perez <fperez@colorado.edu>
#
#  Distributed under the terms of the BSD License.  The full license is in
#  the file COPYING, distributed as part of this software.
#*****************************************************************************

from IPython.utils.coloransi import ColorSchemeTable, TermColors, ColorScheme

def exception_colors():
    """Return a color table with fields for exception reporting.

    The table is an instance of ColorSchemeTable with schemes added for
    'Neutral', 'Linux', 'LightBG' and 'NoColor' and fields for exception handling filled
    in.

    Examples:

    >>> ec = exception_colors()
    >>> ec.active_scheme_name
    ''
    >>> print(ec.active_colors)
    None

    Now we activate a color scheme:
    >>> ec.set_active_scheme('NoColor')
    >>> ec.active_scheme_name
    'NoColor'
    >>> sorted(ec.active_colors.keys())
    ['Normal', 'breakpoint_disabled', 'breakpoint_enabled', 'caret', 'em',
    'excName', 'filename', 'filenameEm', 'line', 'lineno', 'linenoEm', 'name',
    'nameEm', 'normalEm', 'prompt', 'topline', 'vName', 'val', 'valEm']

    """

    ex_colors = ColorSchemeTable()

    # Populate it with color schemes
    C = TermColors  # shorthand and local lookup
    ex_colors.add_scheme(
        ColorScheme(
            "NoColor",
            {
                # The color to be used for the top line
                "topline": C.NoColor,

                # The colors to be used in the traceback
                "filename": C.NoColor,
                "lineno": C.NoColor,
                "name": C.NoColor,
                "vName": C.NoColor,
                "val": C.NoColor,
                "em": C.NoColor,

                # Emphasized colors for the last frame of the traceback
                "normalEm": C.NoColor,
                "filenameEm": C.NoColor,
                "linenoEm": C.NoColor,
                "nameEm": C.NoColor,
                "valEm": C.NoColor,

                # Colors for printing the exception
                "excName": C.NoColor,
                "line": C.NoColor,
                "caret": C.NoColor,
                "Normal": C.NoColor,
                # debugger
                "prompt": C.NoColor,
                "breakpoint_enabled": C.NoColor,
                "breakpoint_disabled": C.NoColor,
            },
        )
    )

    # make some schemes as instances so we can copy them for modification easily
    ex_colors.add_scheme(
        ColorScheme(
            "Linux",
            {
                # The color to be used for the top line
                "topline": C.LightRed,
                # The colors to be used in the traceback
                "filename": C.Green,
                "lineno": C.Green,
                "name": C.Purple,
                "vName": C.Cyan,
                "val": C.Green,
                "em": C.LightCyan,
                # Emphasized colors for the last frame of the traceback
                "normalEm": C.LightCyan,
                "filenameEm": C.LightGreen,
                "linenoEm": C.LightGreen,
                "nameEm": C.LightPurple,
                "valEm": C.LightBlue,
                # Colors for printing the exception
                "excName": C.LightRed,
                "line": C.Yellow,
                "caret": C.White,
                "Normal": C.Normal,
                # debugger
                "prompt": C.Green,
                "breakpoint_enabled": C.LightRed,
                "breakpoint_disabled": C.Red,
            },
        )
    )

    # For light backgrounds, swap dark/light colors
    ex_colors.add_scheme(
        ColorScheme(
            "LightBG",
            {
                # The color to be used for the top line
                "topline": C.Red,

                # The colors to be used in the traceback
                "filename": C.LightGreen,
                "lineno": C.LightGreen,
                "name": C.LightPurple,
                "vName": C.Cyan,
                "val": C.LightGreen,
                "em": C.Cyan,

                # Emphasized colors for the last frame of the traceback
                "normalEm": C.Cyan,
                "filenameEm": C.Green,
                "linenoEm": C.Green,
                "nameEm": C.Purple,
                "valEm": C.Blue,

                # Colors for printing the exception
                "excName": C.Red,
                # "line": C.Brown,  # brown often is displayed as yellow
                "line": C.Red,
                "caret": C.Normal,
                "Normal": C.Normal,
                # debugger
                "prompt": C.Blue,
                "breakpoint_enabled": C.LightRed,
                "breakpoint_disabled": C.Red,
            },
        )
    )

    ex_colors.add_scheme(
        ColorScheme(
            "Neutral",
            {
                # The color to be used for the top line
                "topline": C.Red,
                # The colors to be used in the traceback
                "filename": C.LightGreen,
                "lineno": C.LightGreen,
                "name": C.LightPurple,
                "vName": C.Cyan,
                "val": C.LightGreen,
                "em": C.Cyan,
                # Emphasized colors for the last frame of the traceback
                "normalEm": C.Cyan,
                "filenameEm": C.Green,
                "linenoEm": C.Green,
                "nameEm": C.Purple,
                "valEm": C.Blue,
                # Colors for printing the exception
                "excName": C.Red,
                # line = C.Brown,  # brown often is displayed as yellow
                "line": C.Red,
                "caret": C.Normal,
                "Normal": C.Normal,
                # debugger
                "prompt": C.Blue,
                "breakpoint_enabled": C.LightRed,
                "breakpoint_disabled": C.Red,
            },
        )
    )

    # Hack: the 'neutral' colours are not very visible on a dark background on
    # Windows. Since Windows command prompts have a dark background by default, and
    # relatively few users are likely to alter that, we will use the 'Linux' colours,
    # designed for a dark background, as the default on Windows.
    if os.name == "nt":
        ex_colors.add_scheme(ex_colors['Linux'].copy('Neutral'))

    return ex_colors