[python] 一度に複数のパターンを置換する関数(正規表現を置換前文字列とできる版)

一度に複数のパターンを置換したい場合がある。
その場合、pythonクックブックの同名レシピが参考になる.

そのレシピでは、以下のように、1パスで対応できることに意義を置き、問題が定義されている.
単一の文字列の中の複数の文字列パターンを、同時に（1パス）で置換したい
それに対する解法・考察として、以下３パターンが書かれている.

• シンプルな例
• クロージャーを用いた例
• オブジェクトを用いた例

よくある同問題について、問題と対策について分かりやすく記述されており、このレシピは大いに参考になると思う.




しかし、若干物足りない点があった.

そのレシピの例では、複数のパターンの置換前文字列をディクショナリのキーとして渡すのだが、そのキーについて正規表現を使えるようにはなっていない.
なので、使えるよう少しカスタマイズして作成した.

カスタム前のコード

まずはレシピの最初で書かれている、一度に複数のパターンを置換する関数の、最もシンプルなタイプの関数を紹介する.

def multiple_replace(text,adict):
    """
    一度に複数の文字列を置換する.
    - text中からディクショナリのキーに合致する文字列を探し、対応の値で置換して返す
    """
    # マッチさせたいキー群を正規表現の形にする e.g) (a1|a2|a3...)
    rx = re.compile('|'.join(map(re.escape,adict)))
    def one_xlat(match):
        return adict[match.group(0)]
    return rx.sub(one_xlat, text)

# 使用例
text  = "Larry Wall is the creator of Perl"
adict = {
    "Larry Wall"      : "Guido van Rossum",           
    "creator"       : "Benevolent Dictator for Life",
    "Perl" : "Python",                      
}

after = multiple_replace_re(text,adict)

>>> after
'Guido van Rossum is the Benevolent Dictator for Life of Python'

カスタム後のコード

次に、一度に複数のパターンを置換する関数”正規表現を置換前文字列とできる版)”
を上げておく.

カスタムは上記シンプルなタイプについて行っている.
レシピでは、これを取っ掛かりとして、置換辞書の再利用などを考慮した先の例があるのだが、
ここではその扱いやすいシンプルな関数でカスタマイズしていった.

複数のパターンの置換前文字列をディクショナリのキーとして渡すことを可能としている.

def multiple_replace_re(text,adict):
    """ 一度に複数のパターンを置換する関数
    - text中からディクショナリのキーに合致する文字列を探し、対応の値で置換して返す
    - キーでは、正規表現を置換前文字列とできる
    """
    rx = re.compile('|'.join(adict))
    
    def dedictkey(text):
        """ マッチした文字列の元であるkeyを返す
        """
        for key in adict.keys():
            if re.search(key, text):
                return key

    def one_xlat(match):
        return adict[dedictkey(match.group(0))]

    return rx.sub(one_xlat,text)

# 実行例 
text  = "Larry Wall is the creator of Perl"
adict = {
    "Lar.*all"      : "Guido van Rossum",           
    "creator"       : "Benevolent Dictator for Life",
    "(?:Perl|Ruby)" : "Python",                      
}

after = multiple_replace_re(text,adict)
>>> after
'Guido van Rossum is the Benevolent Dictator for Life of Python'

カスタムした点

• 正規表現のメタ文字を文字列として扱えるようにするメソッド:re.escapeをなくし正規表現をそのまま使用可能に
• マッチした文字列の元であるkeyを返す関数dedictkeyを追加.これにマッチ後文字列を渡し、対応する置換後文字列を取得している.

しょぼい点

• keyの正規表現にだぶってマッチする場合の対処をまったく考えていない
• 他にもエラーの可能性をあまり考慮できていない

この辺りのカバーを使用方法に委ねるという全く持ってダメなプログラムとなっている...
置換内容がごく単純な場合のみに使いどころがあると言えそうだ.

終わりに

1パスで置換することにこだわらなければ、replaceメソッドを用い、置換処理を繰り返していくことでもっと単純なコードが書けるかもしれない.

また、ここでは単に関数そのものをベタにカスタムしている.
クックブックでは、別のカスタム方法がお勧めされており、サブクラスからのオーバーライドを使用したカスタマイズ方法が例に上げられている.

それら例のように、複数パターン置換というよくある例をとり、
クロージャーの使用どころ／オブジェクト化する意義などが簡潔に解説されている点は,
強調しておきたい.これら手法になじめるシンプルな例として、とても参考になる良いレシピだ.

私の例が良いものだとは思えないが、このレシピから出発し、自分の目的に適う置換関数を作成していけると思う.