ipython/IPython/utils/PyColorize.py at python-3.14-dev · krassowski/ipython · GitHub

Repository navigation

History

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

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

import keyword

import os

import sys

import token

import tokenize

import warnings

from io import StringIO

from typing import TypeAlias

import pygments

from pygments.formatters.terminal256 import Terminal256Formatter

from pygments.style import Style

from pygments.styles import get_style_by_name

from pygments.token import Token, _TokenType

from functools import cache

from typing import TypedDict

TokenStream: TypeAlias = list[tuple[_TokenType, str]]

__all__ = ["Parser", "Theme"]

class Symbols(TypedDict):

top_line: str

arrow_body: str

arrow_head: str

_default_symbols: Symbols = {

"top_line": "-",

"arrow_body": "-",

"arrow_head": ">",

}

class Theme:

name: str

base: str | None

extra_style: dict[_TokenType, str]

symbols: Symbols

def __init__(self, name, base, extra_style, *, symbols={}):

self.name = name

self.base = base

self.extra_style = extra_style

self.symbols = {**_default_symbols, **symbols}

self._formatter = Terminal256Formatter(style=self.as_pygments_style())

@cache

def as_pygments_style(self):

if self.base is not None:

base_styles = get_style_by_name(self.base).styles

else:

base_styles = {}

class MyStyle(Style):

styles = {**base_styles, **self.extra_style}

return MyStyle

def format(self, stream: TokenStream) -> str:

return pygments.format(stream, self._formatter)

def make_arrow(self, width: int):

"""generate the leading arrow in front of traceback or debugger"""

if width >= 2:

return (

self.symbols["arrow_body"] * (width - 2)

+ self.symbols["arrow_head"]

+ " "

)

elif width == 1:

return self.symbols["arrow_head"]

return ""

generate_tokens = tokenize.generate_tokens

#############################################################################

### Python Source Parser (does Highlighting)

#############################################################################

_KEYWORD = token.NT_OFFSET + 1

_TEXT = token.NT_OFFSET + 2

# ****************************************************************************

_pygment_token_mapping: dict[int, _TokenType] = {

token.NUMBER: Token.Literal.Number,

token.OP: Token.Operator,

token.STRING: Token.Literal.String,

token.COMMENT: Token.Comment,

token.NAME: Token.Name,

token.ERRORTOKEN: Token.Error,

_KEYWORD: Token.Keyword,

_TEXT: Token.Text,

}

# technically BW is not nocolor, we should have a no-style, style

nocolors_theme = Theme("nocolor", None, {})

linux_theme = Theme(

"linux",

"monokai",

{

Token.Header: "ansibrightred",

Token.LinenoEm: "ansibrightgreen",

Token.Lineno: "ansigreen",

Token.ValEm: "ansibrightblue",

Token.VName: "ansicyan",

Token.Caret: "",

Token.Filename: "ansibrightgreen",

Token.ExcName: "ansibrightred",

Token.Topline: "ansibrightred",

Token.FilenameEm: "ansigreen",

Token.Normal: "",

Token.NormalEm: "ansibrightcyan",

Token.Line: "ansiyellow",

Token.TB.Name: "ansimagenta",

Token.TB.NameEm: "ansibrightmagenta",

Token.Breakpoint: "",

Token.Breakpoint.Enabled: "ansibrightred",

Token.Breakpoint.Disabled: "ansired",

Token.Prompt: "ansibrightgreen",

Token.PromptNum: "ansigreen bold",

Token.OutPrompt: "ansibrightred",

Token.OutPromptNum: "ansired bold",

)

neutral_pygments_equiv = {

Token.Header: "ansired",

Token.LinenoEm: "ansigreen",

Token.Lineno: "ansibrightgreen",

Token.ValEm: "ansiblue",

Token.VName: "ansicyan",

Token.Caret: "",

Token.Filename: "ansibrightgreen",

Token.FilenameEm: "ansigreen",

Token.ExcName: "ansired",

Token.Topline: "ansired",

Token.Normal: "",

Token.NormalEm: "ansicyan",

Token.Line: "ansired",

Token.TB.Name: "ansibrightmagenta",

Token.TB.NameEm: "ansimagenta",

Token.Breakpoint: "",

Token.Breakpoint.Enabled: "ansibrightred",

Token.Breakpoint.Disabled: "ansired",

## specific override of pygments defaults for visibility

Token.Number: "ansigreen",

Token.Operator: "noinherit",

Token.String: "ansiyellow",

Token.Name.Function: "ansiblue",

Token.Name.Class: "bold ansiblue",

Token.Name.Namespace: "bold ansiblue",

Token.Name.Variable.Magic: "ansiblue",

Token.Prompt: "ansigreen",

Token.OutPrompt: "ansired",

}

neutral_pygments_nt = {

**neutral_pygments_equiv,

Token.PromptNum: "ansigreen bold",

Token.OutPromptNum: "ansired bold",

}

neutral_pygments_posix = {

**neutral_pygments_equiv,

Token.PromptNum: "ansibrightgreen bold",

Token.OutPromptNum: "ansibrightred bold",

}

neutral_nt = Theme("neutral:nt", "default", neutral_pygments_nt)

neutral_posix = Theme("neutral:posix", "default", neutral_pygments_posix)

# 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. Changing it here

# avoids affecting the prompt colours rendered by prompt_toolkit, where the

# neutral defaults do work OK.

if os.name == "nt":

neutral_theme = neutral_nt

else:

neutral_theme = neutral_posix

lightbg_theme = Theme(

"lightbg",

"pastie",

{

Token.Header: "ansired",

Token.LinenoEm: "ansigreen",

Token.Lineno: "ansibrightgreen",

Token.ValEm: "ansiblue",

Token.VName: "ansicyan",

Token.Caret: "",

Token.Filename: "ansigreen",

Token.FilenameEm: "ansibrightgreen",

Token.ExcName: "ansired",

Token.Topline: "ansired",

Token.Normal: "",

Token.NormalEm: "ansicyan",

Token.Line: "ansired",

Token.TB.Name: "ansibrightmagenta",

Token.TB.NameEm: "ansimagenta",

Token.Breakpoint: "",

Token.Breakpoint.Enabled: "ansibrightred",

Token.Breakpoint.Disabled: "ansired",

Token.Prompt: "ansibrightblue",

Token.PromptNum: "ansiblue bold",

Token.OutPrompt: "ansibrightred",

Token.OutPromptNum: "ansired bold",

)

PRIDE_RED = "#E40303"

PRIDE_ORANGE = "#FF8C00"

PRIDE_YELLOW = "#FFED00"

PRIDE_GREEN = "#008026"

PRIDE_INDIGO = "#004CFF"

PRIDE_VIOLET = "#732982"

pride_theme = Theme(

"pride",

"pastie",

{

Token.Header: PRIDE_INDIGO,

Token.LinenoEm: f"{PRIDE_GREEN} italic",

Token.Lineno: f"{PRIDE_GREEN} bold",

Token.ValEm: f"{PRIDE_INDIGO} italic",

Token.VName: "ansicyan",

Token.Caret: "",

Token.Filename: f"{PRIDE_YELLOW}",

Token.FilenameEm: f"bg:{PRIDE_VIOLET}",

Token.ExcName: f"{PRIDE_ORANGE}",

Token.Topline: f"{PRIDE_RED}",

Token.Normal: "",

Token.NormalEm: "bold",

Token.Line: "ansired",

Token.TB.Name: "ansibrightmagenta",

Token.TB.NameEm: "ansimagenta",

Token.Breakpoint: "",

Token.Breakpoint.Enabled: "ansibrightred",

Token.Breakpoint.Disabled: "ansired",

Token.Prompt: "ansibrightblue",

Token.Prompt.Continuation.L1: f"ansiwhite bg:{PRIDE_RED}",

Token.Prompt.Continuation.L2: f"ansiwhite bg:{PRIDE_ORANGE}",

Token.Prompt.Continuation.L3: f"ansiblack bg:{PRIDE_YELLOW}",

Token.Prompt.Continuation.L4: f"ansiwhite bg:{PRIDE_GREEN}",

Token.Prompt.Continuation.L5: f"ansiwhite bg:{PRIDE_INDIGO}",

Token.Prompt.Continuation.L6: f"ansiwhite bg:{PRIDE_VIOLET}",

Token.PromptNum: "ansiblue bold",

Token.OutPrompt: "ansibrightred",

Token.OutPromptNum: "ansired bold",

symbols={"arrow_body": "\u2500", "arrow_head": "\u25b6", "top_line": "\u2500"},

)

C1 = "#D52D00"

C2 = "#EF7627"

C3 = "#FF9A56"

White = "#FFFFFF"

C5 = "#D162A4"

C6 = "#B55690"

C7 = "#A30262"

pl = {

# Token.Whitespace: "#bbbbbb",

Token.Comment: "#888888",

Token.String: C5,

Token.String.Escape: C1,

Token.Keyword: f"italic {C2}",

Token.Name.Class: C2,

Token.Name.Exception: C1,

Token.Name.Builtin: C3,

Token.Name.Variable: C6,

Token.Name.Constant: C7,

Token.Name.Decorator: C2,

Token.Number: C7,

Token.Generic.Deleted: f"bg:{C1} #000000",

Token.Generic.Emph: "italic",

Token.Generic.Strong: "bold",

Token.Generic.EmphStrong: "bold italic",

}

pridel_theme = Theme(

"pride:l",

None,

{

Token.Header: C3,

Token.LinenoEm: C3,

Token.Lineno: C2,

Token.ValEm: C2,

Token.VName: C2,

Token.Caret: "",

Token.Filename: C2,

Token.FilenameEm: C3,

Token.ExcName: C1,

Token.Topline: C1,

Token.Normal: "",

Token.NormalEm: "bold",

Token.Line: C2,

Token.TB.Name: C6,

Token.TB.NameEm: C7,

Token.Breakpoint: "",

Token.Breakpoint.Enabled: C1,

Token.Breakpoint.Disabled: C7,

Token.Prompt: C1,

Token.PromptNum: C2,

Token.Prompt.Continuation: C7,

Token.Prompt.Continuation.L1: C2,

Token.Prompt.Continuation.L2: C3,

Token.Prompt.Continuation.L3: White,

Token.Prompt.Continuation.L4: C5,

Token.Prompt.Continuation.L5: C6,

Token.Prompt.Continuation.L6: C7,

Token.OutPrompt: C6,

Token.OutPromptNum: C5,

**pl,

symbols={"arrow_body": "\u2500", "arrow_head": "\u25b6", "top_line": "\u2500"},

)

theme_table: dict[str, Theme] = {

"nocolor": nocolors_theme,

"linux": linux_theme,

"neutral": neutral_theme,

"neutral:nt": neutral_nt,

"neutral:posix": neutral_posix,

"lightbg": lightbg_theme,

"pride": pride_theme,

"pride:l": pridel_theme,

}

class Parser:

"""Format colored Python source."""

_theme_name: str

def __init__(self, out=sys.stdout, *, theme_name: str = None):

"""Create a parser with a specified color table and output channel.

Call format() to process code.

"""

assert theme_name is not None

self.out = out

self.pos = None

self.lines = None

self.raw = None

if theme_name is not None:

if theme_name in ["Linux", "LightBG", "Neutral", "NoColor"]:

warnings.warn(

f"Theme names and color schemes are lowercase in IPython 9.0 use {theme_name.lower()} instead",

DeprecationWarning,

stacklevel=2,

)

theme_name = theme_name.lower()

if not theme_name:

self.theme_name = "nocolor"

else:

self.theme_name = theme_name

@property

def theme_name(self):

return self._theme_name

@theme_name.setter

def theme_name(self, value):

assert value == value.lower()

self._theme_name = value

@property

def style(self):

assert False

return self._theme_name

@style.setter

def set(self, val):

assert False

assert val == val.lower()

self._theme_name = val

def format(self, raw, out=None):

return self.format2(raw, out)[0]

def format2(self, raw, out=None):

"""Parse and send the colored source.

If out is not specified, the defaults (given to constructor) are used.

out should be a file-type object. Optionally, out can be given as the

string 'str' and the parser will automatically return the output in a

string."""

string_output = 0

if out == "str" or self.out == "str" or isinstance(self.out, StringIO):

# XXX - I don't really like this state handling logic, but at this

# point I don't want to make major changes, so adding the

# isinstance() check is the simplest I can do to ensure correct

# behavior.

out_old = self.out

self.out = StringIO()

string_output = 1

elif out is not None:

self.out = out

else:

raise ValueError(

'`out` or `self.out` should be file-like or the value `"str"`'

)

# Fast return of the unmodified input for nocolor scheme

# TODO:

if self.theme_name == "nocolor":

error = False

self.out.write(raw)

if string_output:

return raw, error

return None, error

# local shorthands

# Remove trailing whitespace and normalize tabs

self.raw = raw.expandtabs().rstrip()

# store line offsets in self.lines

self.lines = [0, 0]

pos = 0

raw_find = self.raw.find

lines_append = self.lines.append

while True:

pos = raw_find("\n", pos) + 1

if not pos:

break

lines_append(pos)

lines_append(len(self.raw))

# parse the source and write it

self.pos = 0

text = StringIO(self.raw)

error = False

try:

for atoken in generate_tokens(text.readline):

self(*atoken)

except tokenize.TokenError as ex:

msg = ex.args[0]

line = ex.args[1][0]

self.out.write(

theme_table[self.theme_name].format(

[

(Token, "\n\n"),

(

Token.Error,

f"*** ERROR: {msg}{self.raw[self.lines[line] :]}",

(Token, "\n"),

]

)

error = True

self.out.write(

theme_table[self.theme_name].format(

[

(Token, "\n"),

]

)

if string_output:

output = self.out.getvalue()

self.out = out_old

return (output, error)

return (None, error)

def _inner_call_(self, toktype, toktext, start_pos):

"""like call but write to a temporary buffer"""

srow, scol = start_pos

# calculate new positions

oldpos = self.pos

newpos = self.lines[srow] + scol

self.pos = newpos + len(toktext)

# send the original whitespace, if needed

if newpos > oldpos:

acc = self.raw[oldpos:newpos]

else:

acc = ""

# skip indenting tokens

if toktype in [token.INDENT, token.DEDENT]:

self.pos = newpos

return acc

# map token type to a color group

if token.LPAR <= toktype <= token.OP:

toktype = token.OP

elif toktype == token.NAME and keyword.iskeyword(toktext):

toktype = _KEYWORD

pyg_tok_type = _pygment_token_mapping.get(toktype, Token.Text)

# send text, pygments should take care of splitting on newline and resending

# the correct self.colors after the new line, which is necessary for pagers

acc += theme_table[self.theme_name].format([(pyg_tok_type, toktext)])

return acc

def __call__(self, toktype, toktext, start_pos, end_pos, line):

"""Token handler, with syntax highlighting."""

self.out.write(self._inner_call_(toktype, toktext, start_pos))

ipython/IPython/utils/PyColorize.py at python-3.14-dev · krassowski/ipython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

PyColorize.py

Latest commit

History

Breadcrumbs

PyColorize.py

File metadata and controls