exporters
This module provides various methods and utilities to turn TIM into HTML & SVG.
prettify_xml(xml)
Prettifies some XML.
Source code in pytermgui/exporters.py
106 107 108 109 110 111 112 |
|
to_html(obj, prefix=None, inline_styles=False, include_background=True, vertical_offset=0.0, horizontal_offset=0.0, formatter=HTML_FORMAT, joiner='\n')
Creates a static HTML representation of the given object.
Note that the output HTML will not be very attractive or easy to read. This is because these files probably aren't meant to be read by a human anyways, so file sizes are more important.
If you do care about the visual style of the output, you can run it through some prettifiers to get the result you are looking for.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj |
Widget | StyledText | str
|
The object to represent. Takes either a Widget or some markup text. |
required |
prefix |
str | None
|
The prefix included in the generated classes, e.g. instead of |
None
|
inline_styles |
bool
|
If set, styles will be set for each span using the inline |
False
|
include_background |
bool
|
Whether to include the terminal's background color in the output. |
True
|
Source code in pytermgui/exporters.py
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 |
|
to_svg(obj, prefix=None, chrome=True, inline_styles=False, title='PyTermGUI', formatter=SVG_FORMAT)
Creates an SVG screenshot of the given object.
This screenshot tries to mimick what the Kitty terminal looks like on MacOS,
complete with the menu buttons and drop shadow. The title
argument will be
displayed in the window's top bar.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj |
Widget | StyledText | str
|
The object to represent. Takes either a Widget or some markup text. |
required |
prefix |
str | None
|
The prefix included in the generated classes, e.g. instead of |
None
|
chrome |
bool
|
Sets the visibility of the window "chrome", e.g. the part of the SVG that mimicks the outside border of a terminal. |
True
|
inline_styles |
bool
|
If set, styles will be set for each span using the inline |
False
|
title |
str
|
A string to display in the top bar of the fake terminal. |
'PyTermGUI'
|
formatter |
str
|
The formatting string to use. Inspect |
SVG_FORMAT
|
Source code in pytermgui/exporters.py
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 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 |
|
token_to_css(token, invert=False)
Finds the CSS representation of a token.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
token |
Token
|
The token to represent. |
required |
invert |
bool
|
If set, the role of background & foreground colors are flipped. |
False
|
Source code in pytermgui/exporters.py
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 |
|