web-dev-qa-db-ja.com

pythonの文字列からANSIエスケープシーケンスを削除するにはどうすればよいですか

これは私の文字列です：

'ls\r\n\x1b[00m\x1b[01;31mexamplefile.Zip\x1b[00m\r\n\x1b[01;31m'

コードを使用してSSHコマンドから出力を取得していましたが、文字列に「examplefile.Zip」のみが含まれるようにします

余分なエスケープシーケンスを削除するために使用できるものは何ですか？

pythonstringescapingansi-escape
53
SpartaSixZero

正規表現を使用してそれらを削除します。

import re

# 7-bit C1 ANSI sequences
ansi_escape = re.compile(r'''
    \x1B    # ESC
    [@-_]   # 7-bit C1 Fe
    [0-?]*  # Parameter bytes
    [ -/]*  # Intermediate bytes
    [@-~]   # Final byte
''', re.VERBOSE)
result = ansi_escape.sub('', sometext)

または、VERBOSEフラグなしの圧縮形式：

ansi_escape = re.compile(r'\x1B[@-_][0-?]*[ -/]*[@-~]')
result = ansi_escape.sub('', sometext)

デモ：

>>> import re
>>> ansi_escape = re.compile(r'\x1B[@-_][0-?]*[ -/]*[@-~]')
>>> sometext = 'ls\r\n\x1b[00m\x1b[01;31mexamplefile.Zip\x1b[00m\r\n\x1b[01;31m'
>>> ansi_escape.sub('', sometext)
'ls\r\nexamplefile.Zip\r\n'

上記の正規表現は、すべての7ビットANSI C1エスケープシーケンスを対象としていますが、8ビットC1エスケープシーケンスオープナーはnotではありません。後者は、同じバイト範囲が異なる意味を持つ今日のUTF-8の世界では決して使用されません。

8ビットコードもカバーする必要がある場合（そして、おそらく、bytes値を操作する場合）、正規表現は次のようなバイトパターンになります。

# 7-bit and 8-bit C1 ANSI sequences
ansi_escape_8bit = re.compile(br'''
    (?: # either 7-bit C1, two bytes, ESC Fe
        \x1B
        [@-_]
    |   # or a single 8-bit byte Fe
        [\x80-\x9F]
    )
    [0-?]*  # Parameter bytes
    [ -/]*  # Intermediate bytes
    [@-~]   # Final byte
''', re.VERBOSE)
result = ansi_escape_8bit.sub(b'', somebytesvalue)

に凝縮することができます

# 7-bit and 8-bit C1 ANSI sequences
ansi_escape_8bit = re.compile(br'(?:\x1B[@-_]|[\x80-\x9F])[0-?]*[ -/]*[@-~]')
result = ansi_escape_8bit.sub(b'', somebytesvalue)

詳細については、以下を参照してください。

指定した例には、\x1B[またはESC [開始バイトでマークされた4つのCSI（Control Sequence Introducer）コードが含まれ、それぞれにSGRが含まれています（Select Graphic Rendition）コードは、それぞれがmで終わるためです。それらの間のパラメーター（;セミコロンで区切られた）は、使用するグラフィックレンディション属性を端末に指示します。したがって、\x1B[....mシーケンスごとに、使用される3つのコードは次のとおりです。

  • 0（またはこの例では00）：reset、すべての属性を無効にする
  • 1 (or 01 in the example): bold
  • 31：red（フォアグラウンド）

ただし、ANSIにはCSI SGRコードだけではありません。 CSIだけで、カーソルを制御したり、行をクリアしたり、ディスプレイ全体を表示したり、スクロールしたりすることもできます（端末がもちろんこれをサポートしている場合）。また、CSI以外にも、代替フォント（SS2およびSS3）を選択するコード、「プライベートメッセージ」（パスワードを考える）を送信する、端末と通信する（DCS）、 OS（OSC）、またはアプリケーション自体（APC、アプリケーションが通信ストリームにカスタム制御コードをピギーバックする方法）、および文字列の定義に役立つ追加コード（SOS、文字列の開始、ST文字列ターミネータ）またはすべてをベース状態にリセットする（RIS）。上記の正規表現はこれらすべてをカバーしています。

99
Martijn Pieters

この質問に対する受け入れられた答えは、色とフォントの効果のみを考慮しています。カーソルの位置、消去、スクロール領域など、「m」で終わらないシーケンスがたくさんあります。

コントロールシーケンス（別名ANSIエスケープシーケンス）の完全な正規表現は

/(\x9B|\x1B\[)[0-?]*[ -\/]*[@-~]/

ECMA-48セクション5.4 および ANSIエスケープコード を参照してください

42
Jeff

関数

Martijn Pieters♦の回答 と Jeffの正規表現 に基づきます。

def escape_ansi(line):
    ansi_escape = re.compile(r'(?:\x1B[@-_]|[\x80-\x9F])[0-?]*[ -/]*[@-~]')
    return ansi_escape.sub('', line)

テスト

def test_remove_ansi_escape_sequence(self):
    line = '\t\u001b[0;35mBlabla\u001b[0m                                  \u001b[0;36m172.18.0.2\u001b[0m'

    escaped_line = escape_ansi(line)

    self.assertEqual(escaped_line, '\tBlabla                                  172.18.0.2')

テスト中

自分で実行する場合は、python3（より良いユニコードのサポート、blablabla）。テストファイルは次のようになります。

import unittest
import re

def escape_ansi(line):
    …

class TestStringMethods(unittest.TestCase):
    def test_remove_ansi_escape_sequence(self):
    …

if __== '__main__':
    unittest.main()
25
Édouard Lopez

提案された正規表現は私のためにトリックをしなかったので、私は自分の1つを作成しました。以下は、python見つかった仕様に基づいて作成した正規表現 here

ansi_regex = r'\x1b(' \
             r'(\[\??\d+[hl])|' \
             r'([=<>a-kzNM78])|' \
             r'([\(\)][a-b0-2])|' \
             r'(\[\d{0,2}[ma-dgkjqi])|' \
             r'(\[\d+;\d+[hfy]?)|' \
             r'(\[;?[hf])|' \
             r'(#[3-68])|' \
             r'([01356]n)|' \
             r'(O[mlnp-z]?)|' \
             r'(/Z)|' \
             r'(\d+)|' \
             r'(\[\?\d;\d0c)|' \
             r'(\d;\dR))'
ansi_escape = re.compile(ansi_regex, flags=re.IGNORECASE)

次のスニペット（基本的にascii-table.comページからのコピーペースト）で正規表現をテストしました

\x1b[20h    Set
\x1b[?1h    Set
\x1b[?3h    Set
\x1b[?4h    Set
\x1b[?5h    Set
\x1b[?6h    Set
\x1b[?7h    Set
\x1b[?8h    Set
\x1b[?9h    Set
\x1b[20l    Set
\x1b[?1l    Set
\x1b[?2l    Set
\x1b[?3l    Set
\x1b[?4l    Set
\x1b[?5l    Set
\x1b[?6l    Set
\x1b[?7l    Reset
\x1b[?8l    Reset
\x1b[?9l    Reset
\x1b=   Set
\x1b>   Set
\x1b(A  Set
\x1b)A  Set
\x1b(B  Set
\x1b)B  Set
\x1b(0  Set
\x1b)0  Set
\x1b(1  Set
\x1b)1  Set
\x1b(2  Set
\x1b)2  Set
\x1bN   Set
\x1bO   Set
\x1b[m  Turn
\x1b[0m Turn
\x1b[1m Turn
\x1b[2m Turn
\x1b[4m Turn
\x1b[5m Turn
\x1b[7m Turn
\x1b[8m Turn
\x1b[1;2    Set
\x1b[1A Move
\x1b[2B Move
\x1b[3C Move
\x1b[4D Move
\x1b[H  Move
\x1b[;H Move
\x1b[4;3H   Move
\x1b[f  Move
\x1b[;f Move
\x1b[1;2    Move
\x1bD   Move/scroll
\x1bM   Move/scroll
\x1bE   Move
\x1b7   Save
\x1b8   Restore
\x1bH   Set
\x1b[g  Clear
\x1b[0g Clear
\x1b[3g Clear
\x1b#3  Double-height
\x1b#4  Double-height
\x1b#5  Single
\x1b#6  Double
\x1b[K  Clear
\x1b[0K Clear
\x1b[1K Clear
\x1b[2K Clear
\x1b[J  Clear
\x1b[0J Clear
\x1b[1J Clear
\x1b[2J Clear
\x1b5n  Device
\x1b0n  Response:
\x1b3n  Response:
\x1b6n  Get
\x1b[c  Identify
\x1b[0c Identify
\x1b[?1;20c Response:
\x1bc   Reset
\x1b#8  Screen
\x1b[2;1y   Confidence
\x1b[2;2y   Confidence
\x1b[2;9y   Repeat
\x1b[2;10y  Repeat
\x1b[0q Turn
\x1b[1q Turn
\x1b[2q Turn
\x1b[3q Turn
\x1b[4q Turn
\x1b<   Enter/exit
\x1b=   Enter
\x1b>   Exit
\x1bF   Use
\x1bG   Use
\x1bA   Move
\x1bB   Move
\x1bC   Move
\x1bD   Move
\x1bH   Move
\x1b12  Move
\x1bI  
\x1bK  
\x1bJ  
\x1bZ  
\x1b/Z 
\x1bOP 
\x1bOQ 
\x1bOR 
\x1bOS 
\x1bA  
\x1bB  
\x1bC  
\x1bD  
\x1bOp 
\x1bOq 
\x1bOr 
\x1bOs 
\x1bOt 
\x1bOu 
\x1bOv 
\x1bOw 
\x1bOx 
\x1bOy 
\x1bOm 
\x1bOl 
\x1bOn 
\x1bOM 
\x1b[i 
\x1b[1i
\x1b[4i
\x1b[5i

これが他の人の助けになることを願っています:)

7
kfir