ansimarkup 1.4.0

基本

fromansimarkupimportparse,ansiprint# parse() converts the tags to the corresponding ansi escape sequence.parse("<b>bold</b> <d>dim</d>")# ansiprint() works exactly like print(), but first runs parse() on all arguments.ansiprint("<b>bold</b>","<d>dim</d>")ansiprint("<b>bold</b>","<d>dim</d>",sep=":",file=sys.stderr)

颜色和样式

# Colors may be specified in one of several ways.parse("<red>red foreground</red>")parse("<RED>red background</RED>")parse("<fg red>red foreground</fg red>")parse("<bg red>red background</bg red>")# Xterm, hex and rgb colors are accepted by the <fg> and <bg> tags.parse("<fg 86>aquamarine foreground</fg 86>")parse("<bg #00005f>dark blue background</bg #00005f>")parse("<fg 0,95,0>dark green foreground</fg 0,95,0>")# Tags may be nested.parse("<r><Y>red text on a yellow foreground</Y></r>")# The above may be more concisely written as:parse("<r,y>red text on a yellow background</r,y>")# This shorthand also supports style tags.parse("<b,r,y>bold red text on a yellow background</b,r,y>")parse("<b,r,>bold red text</b,r,>")parse("<b,,y>bold regular text on a yellow background</b,,y>")# Unrecognized tags are left as-is.parse("<b><element1></element1></b>")

有关标记标记的列表，请参阅tags.py。

用户定义的标签

fromansimarkupimportAnsiMarkup,parseuser_tags={# Add a new tag (e.g. we want <info> to expand to "<bold><green>")."info":parse("<b><g>")# The ansi escape sequence can be used directly."info":"e\x1b[32m\x1b[1m",# Tag names may also be callables."err":lambda:parse("<r>")# Colors may also be given convenient tag names."orange":parse("<fg #d78700>"),# User-defined tags always take precedence over existing tags."bold":parse("<dim>")}am=AnsiMarkup(tags=user_tags)am.parse("<info>bold green</info>")am.ansiprint("<err>red</err>")# Calling the instance is equivalent to calling its parse method.am("<b>bold</b>")==am.parse("<b>bold</b>")

对齐和长度

对齐格式化字符串可能很困难，因为呈现的 字符串与可打印字符数不同。考虑这个例子：

>>>a='| {:30} |'.format('abc')>>>b='| {:30} |'.format(parse('<b>abc</b>'))>>>print(a,b,sep='\n')|abc||abc|

可以使用ansistring函数或 AnsiMarkup.string(markup)方法，它具有以下有用的属性：

>>>s=ansistring('<b>abc</b>')>>>print(repr(s),'->',s)<b>abc</b>->abc# abc is printed in bold>>>len(s),len(am.parse('<b>abc</b>'),s.delta3,11,8

在delta属性的帮助下，很容易将 以上示例：

>>>s=ansistring('<b>abc</b>')>>>a='| {:{width}} |'.format('abc',width=30)>>>b='| {:{width}} |'.format(s,width=(30+s.delta))>>>print(a,b,sep='\n')|abc||abc|

其他功能

通过将tag_sep参数传递给 AnsiMarkup：

fromansimarkupimportAnsiMarkupam=AnsiMarkup(tag_sep="{}")am.parse("{b}{r}bold red{/b}{/r}")

可以使用strip()方法删除标记：

fromansimarkupimportAnsiMarkupam=AnsiMarkup()am.strip("<b><r>bold red</b></r>")

strict选项指示解析器在打开时引发MismatchedTag。 标记没有相应的结束标记：

fromansimarkupimportAnsiMarkupam=AnsiMarkup(strict=True)am.parse("<r><b>bold red")# ansimarkup.MismatchedTag: opening tag "<r>" has no corresponding closing tag

命令行

ansimarkup也可以在命令行上使用。这就好像一切 参数被传递给ansiprint()：

$ python -m ansimarkup "<b>bold</b>" "<red>red</red>"

日志格式化程序

ansimarkup还为标准库提供了格式化程序日志记录 模块。它可以用作：

importloggingfromansimarkup.logformatterimportAnsiMarkupFormatterlog=logging.getLogger()hdl=logging.StreamHandler()fmt=AnsiMarkupFormatter()hdl.setFormatter(fmt)log.addHandler(hdl)log.info("<b>bold text</b>")

窗口

ansimarkup在内部使用colorama库，这意味着windows 第一次运行时支持ANSI转义序列：

importcoloramacolorama.init()

有关Windows支持的更多信息，请参阅 colorama文档。