文字列に対して、検索や置換、検証などをする方法として正規表現を使用する方法が挙げられる。今回は、Pythonでの正規表現を使うために使用するモジュールreについて解説をしていこうと思う。
reモジュールを使用するには以下のコードが必要である。
import re
正規表現オブジェクトre.Patternにコンパイルをする。
コンパイルすることで、matchやsearchなどを使ってマッチングが出来るようになる。
だが、後述するre.matchやre.searchでもマッチングが出来るため、少ないマッチング回数であれば当関数を使う必要性はない
pattern = re.compile("吾輩は[猫犬]")
match = pattern.match("吾輩は犬である。名前はまだ無い。")
print(f"type(pattern) : {type(pattern)}, type(match) : {type(match)}")
print(match, end = "\n\n")
# 上の処理と下の処理は同等である
matcn = re.match(
pattern = "吾輩は[猫犬]",
string = "吾輩は犬である。名前はまだ無い。"
)
print(f"type(match) : {type(match)}")
print(match)
type(pattern) : <class 're.Pattern'>, type(match) : <class 're.Match'>
<re.Match object; span=(0, 4), match='吾輩は犬'>
type(match) : <class 're.Match'>
<re.Match object; span=(0, 4), match='吾輩は犬'>
この関数は、先ほどまでに紹介した通りである。
petternがマッチする最初の位置を探して、対応するre.Matchを返す。
文字列内でマッチしなければNoneを返す。
match = re.search(
pattern = "猫",
string = "吾輩は猫である。名前はまだ無い。"
)
print(type(match))
print(match)
<class 're.Match'>
<re.Match object; span=(3, 4), match='猫'>
stringの先頭の文字がpatternとマッチする場合のみre.Matchを返す。
それ以外は全てNoneとして返す。
match = re.match(
pattern = "猫",
string = "吾輩は猫である。名前はまだ無い。"
)
print(match)
match = re.match(
pattern = "吾輩",
string = "吾輩は猫である。名前はまだ無い。"
)
print(match)
None
<re.Match object; span=(0, 2), match='吾輩'>
string全体がpatternにマッチする場合のみ、re.Matchを返す。
それ以外は全てNoneを返す。
match = re.fullmatch(
pattern = "猫",
string = "吾輩は猫である。名前はまだ無い。"
)
print(match)
match = re.fullmatch(
pattern = "吾輩は猫である。名前はまだ無い。",
string = "吾輩は猫である。名前はまだ無い。"
)
print(match)
None
<re.Match object; span=(0, 16), match='吾輩は猫である。名前はまだ無い。'>
patternにマッチするstringの部分で分割する。
戻り値はリストで返される。
match = re.split(
pattern = "l",
string = "Hello, World!"
)
print(match)
match = re.split(
pattern = " ", # 半角スペース
string = "Hello, World!"
)
print(match)
['He', '', 'o, Wor', 'd!']
['Hello,', 'World!']
['Hello, World!']
patternにマッチする全ての文字列をリストで返す。
match = re.findall(
pattern = r"g[a-z]*",
string = "Let's go to the baseball game!"
)
print(match)
match = re.findall(
pattern = r"猫",
string = "Let's go to the baseball game!"
)
print(match)
['go', 'game']
[]
注意点は、正規表現を使わずpatternを記述してもあまり意味が無いということだ。（単語の数を数える程度には使えるだろう）
match = re.findall(
pattern = r"base",
string = "base base kick kick base kick kick"
)
print(match)
print(len(match))
['base', 'base', 'base']
3
patternに当てはまる全ての文字列を、順々に表示するイテレータを作成する。
作成されるイテレータの型はcallable_iterator。
因みに、「イテレータとは何か？」については私の記事でも紹介をしている。
match = re.finditer(
pattern = r"t[a-z]*",
string = "I want to go to the game too."
)
print(type(match))
for m in match:
print(m)
<class 'callable_iterator'>
<re.Match object; span=(5, 6), match='t'>
<re.Match object; span=(7, 9), match='to'>
<re.Match object; span=(13, 15), match='to'>
<re.Match object; span=(16, 19), match='the'>
<re.Match object; span=(25, 28), match='too'>
patternにマッチするstringの部分をrepl引数に置き換える。
countに数値を入れることで、置き換える回数を指定することが出来る。
戻り値はstrで返される。
repl引数には関数をいれることも可能であり、関数にはre.Matchクラスが渡されるらしい。
match = re.sub(
pattern = r"犬",
repl = "猫",
string = "犬の名前はまだ無い。"
)
print(match)
match = re.sub(
pattern = "[a-z]+@",
repl = "****@",
string = "google@gmail.com, yahoo@co.jp ant exapmle@test.org",
count = 2 # 置換回数
)
print(match)
猫の名前はまだ無い。
****@gmail.com, ****@co.jp ant exapmle@test.org
やっていることは、re.subと変わらない。
ただ、戻り値が(置換された文字列, 置換した回数)のタプル型に変わる。
match = re.subn(
pattern = r"犬",
repl = "猫",
string = "犬の名前はまだ無い。"
)
print(type(match))
print(match)
match = re.subn(
pattern = "[a-z]+@",
repl = "****@",
string = "google@gmail.com, yahoo@co.jp ant exapmle@test.org",
count = 2 # 置換回数
)
print(type(match))
print(match)
<class 'tuple'>
('猫の名前はまだ無い。', 1)
<class 'tuple'>
('****@gmail.com, ****@co.jp ant exapmle@test.org', 2)
patternに渡した文字列に特殊文字が含まれている場合、エスケープしてくれる関数。
引数はpatternのみで、戻り値はstr。
python3.7以降は正規表現で特殊な意味を持つ文字のみがエスケープされるようになった。
text = re.escape("https://www.python.org")
print(type(text))
print(text)
text = re.escape("!#$%&'*+-.^_`|~:")
print(text)
<class 'str'>
https://www\.python\.org
!\#\$%\&'\*\+\-\.\^_`\|\~:
reモジュールのキャッシュをクリアするためのメソッド。
キャッシュは過去にコンパイルされた正規表現を保持することで速度向上につながるもの。
内部的には見た感じ、re._cacheというデータがキャッシュの役割となっており、dictで管理されている。
pattern1 = re.compile("猫")
pattern2 = re.compile("犬")
pattern3 = re.compile("吾輩は[猫犬]")
print(f"cache size : {len(re._cache)}")
re.purge()
print(f"cache size : {len(re._cache)}")
cache size : 3
cache size : 0
実際にcacheのサイズが変わっていることが確認できた。
具体的な内部仕様を見たい場合は、この辺りを見ると良い。
reモジュールに存在する唯一の例外である。
有効な正規表現ではないものが含まれていた場合に、出力される。
当たり前ではあるが、マッチしないだけの場合は例外にはならない。
python3.12までは、この例外はre.errorであった。結構わかりやすくなった！
try:
re.compile("*") # 無効な正規表現
except re.error as e:
print(e)
raise re.error("エラーが発生しました。")
nothing to repeat at position 0
---------------------------------------------------------------------------
error Traceback (most recent call last)
Cell In[70], line 6
3 except re.error as e:
4 print(e)
----> 6 raise re.error("エラーが発生しました。")
error: エラーが発生しました。
上記コードは、pyton3.11にて実行しているため、re.errorを使用している。