python 正则表达式 re 模块总结

孤独中，你可以获得一切，除了品格。—— 司汤达《红与黑》

概述

前面一篇文章 python使用正则表达式从json字符串中取出特定字段的值 简单使用了 re 模块的方法，但是对其他的方法并不熟悉，为了更全面的了解和使用 python 中的 re，这里将自己学习的过程记录下来。

使用爬虫爬取网页数据的过程中，需要利用各种工具解析网页中的数据，比如：etree，BeautifulSoup，scrapy 等工具，但是功能最强大的还是正则表达式，下面将对 python 的 re 模块方法做一个总结。

Python 通过 re 模块提供对正则表达式的支持。使用 re 的一般步骤是：

1. 使用 re.compile(正则表达式) 将正则表达式的字符串形式编译为Pattern实例
2. 使用Pattern实例提供的方法处理文本并获得匹配结果（一个Match实例）
3. 使用Match实例获得信息，进行其他的操作

一个简单的例子：

# -*- coding: utf-8 -*-
import re

if __name__ == '__main__':
    # 将正则表达式编译成Pattern对象
    pattern = re.compile(r'hello')

    # 使用Pattern匹配文本，获得匹配结果，无法匹配时将返回None
    match = pattern.match('hello world!')

    if match:
        # 使用Match获得分组信息
        print(match.group()) # 输出结果：hello
        

使用原生字符串定义正则表达式可以方便的解决转义字符的问题

原生字符串的定义方式为：r''

有了原生字符串，不需要手动添加转义符号，它会自动转义，写出来的表达式也更直观。

1. 使用 re

re.compile(strPattern[, flag]):

这个方法是Pattern类的工厂方法，用于将字符串形式的正则表达式编译为Pattern对象。

第一个参数：正则表达式字符串

第二个参数（可选）：是匹配模式，取值可以使用按位或运算符'|'表示同时生效，比如 re.I | re.M。

可选值如下：

• re.I(re.IGNORECASE): 忽略大小写（括号内是完整写法，下同）

• M(MULTILINE): 多行模式，改变'^'和'$'的行为

• S(DOTALL): 点任意匹配模式，改变'.'的行为

• L(LOCALE): 使预定字符类 \w \W \b \B \s \S 取决于当前区域设定

• U(UNICODE): 使预定字符类 \w \W \b \B \s \S \d \D 取决于unicode定义的字符属性

• X(VERBOSE): 详细模式。这个模式下正则表达式可以是多行，忽略空白字符，并可以加入注释。以下两个正则表达式是等价的：

  a = re.compile(r"""\d +  # the integral part
                     \.    # the decimal point
                     \d *  # some fractional digits""", re.X)
  b = re.compile(r"\d+\.\d*")
  

re 提供了众多模块方法用于完成正则表达式的功能。这些方法可以使用Pattern实例的相应方法替代，唯一的好处是少写一行re.compile()代码，但同时也无法复用编译后的Pattern对象。这些方法将在Pattern类的实例方法部分一起介绍。如上面这个例子可以简写为：

m = re.match(r'hello', 'hello world!')
print m.group()

2. 使用 Pattern

Pattern 对象是一个编译好的正则表达式，通过 Pattern 提供的一系列方法可以对文本进行匹配查找。

Pattern 对象不能直接实例化，必须使用 re.compile() 来获取。

2.1 Pattern 对象的属性

Pattern 提供了几个可读属性用于获取表达式的相关信息：

1. pattern: 编译时用的表达式字符串。

2. flags: 编译时用的匹配模式，数字形式。

3. groups: 表达式中分组的数量。

4. groupindex: 以表达式中有别名的组的别名为键、以该组对应的编号为值的字典，没有别名的组不包含在内。

# -*- coding: utf-8 -*-
import re

if __name__ == '__main__':
    text = 'hello world'
    p = re.compile(r'(\w+) (\w+)(?P<sign>.*)', re.DOTALL)

    print("p.pattern:", p.pattern)
    print("p.flags:", p.flags)
    print("p.groups:", p.groups)
    print("p.groupindex:", p.groupindex)

输出结果如下：

p.pattern: (\w+) (\w+)(?P<sign>.*)
p.flags: 48
p.groups: 3
p.groupindex: {'sign': 3}

2.2 Pattern 对象的方法

1. match(string[, pos[, endpos]]) | re.match(pattern, string[, flags]):

如果 string 的 开始位置 能够找到这个正则样式的任意个匹配，就返回一个相应的 Match对象。

如果匹配过程中pattern无法匹配，或者匹配未结束就已到达endpos，则返回None。

pos 和endpos 的默认值分别为 0 和 len(string)；

re.match() 无法指定这两个参数，参数flags用于编译pattern时指定匹配模式。

注意：这个方法并不是完全匹配。当pattern结束时若string还有剩余字符，仍然视为成功。想要完全匹配，可以在表达式末尾加上边界匹配符'$'。

2. search(string[, pos[, endpos]]) | re.search(pattern, string[, flags]):

这个方法用于查找字符串中可以匹配成功的子串。

从string的pos下标处起尝试匹配pattern，如果pattern结束时仍可匹配，则返回一个Match对象；

若无法匹配，则将pos加1后重新尝试匹配；直到pos=endpos时仍无法匹配则返回None。

pos和endpos的默认值分别为 0 和 len(string)；

re.search()无法指定这两个参数，参数flags用于编译pattern时指定匹配模式。

一个简单的例子：

# -*- coding: utf-8 -*-
import re

if __name__ == '__main__':
    # 将正则表达式编译成Pattern对象
    pattern = re.compile(r'world')

    # 使用search()查找匹配的子串，不存在能匹配的子串时将返回None
    # 这个例子中使用match()无法成功匹配
    match = pattern.search('hello world!')

    if match:
        # 使用Match获得分组信息
        print(match.group()) # 输出结果：world

注意 match 方法 和 search 方法的区别

3. split(string[, maxsplit]) | re.split(pattern, string[, maxsplit]):

按照能够匹配的子串将string分割后返回列表。

maxsplit 用于指定最大分割次数，不指定将全部分割。

# -*- coding: utf-8 -*-
import re

if __name__ == '__main__':
    p = re.compile(r'\d+')
    # 按照数字分隔字符串
    print(p.split('one1two2three3four4')) # 输出结果：['one', 'two', 'three', 'four', '']

4. findall(string[, pos[, endpos]]) | re.findall(pattern, string[, flags]):

搜索 string，以列表形式返回全部能匹配的子串。

#!/usr/bin/env python
# -*- coding:utf-8 -*-
import re

if __name__ == '__main__':
    p = re.compile(r'\d+')
    # 找到所有的数字，以列表的形式返回
    print(p.findall('one1two2three3four4')) # 输出结果：['1', '2', '3', '4']

5. finditer(string[, pos[, endpos]]) | re.finditer(pattern, string[, flags]):

搜索 string，返回一个顺序访问每一个匹配结果（Match对象）的迭代器。

#!/usr/bin/env python
# -*- coding:utf-8 -*-
import re

if __name__ == '__main__':
    p = re.compile(r'\d+')
    # 返回一个顺序访问每一个匹配结果（`Match`对象）的迭代器
    for m in p.finditer('one1two2three3four4'):
        print(m.group())  # 输出结果：1 2 3 4

6. sub(repl, string[, count]) | re.sub(pattern, repl, string[, count]):

使用 repl 替换 string 中每一个匹配的子串后返回替换后的字符串。
当 repl 是一个字符串时，可以使用 \id 或 \g<id> 、\g<name>引用分组，但不能使用编号0。
当 repl 是一个方法时，这个方法应当只接受一个参数（Match对象），并返回一个字符串用于替换（返回的字符串中不能再引用分组）。
count用于指定最多替换次数，不指定时全部替换。

#!/usr/bin/env python
# -*- coding:utf-8 -*-
import re

if __name__ == '__main__':
    p = re.compile(r'(\w+) (\w+)')
    s = 'i say, hello world!'

    print(p.sub(r'\1 \2 hi', s))  # 输出结果：i say hi, hello world hi!

    def func(m):
        return m.group(1).title() + ' ' + m.group(2).title()

    print(p.sub(func, s))  # 输出结果：I Say, Hello World!

7. subn(repl, string[, count]) |re.sub(pattern, repl, string[, count]):

subn() 方法与 sub() 方法的区别是返回结果不同：

subn() 方法返回的结果是一个元组：(替换后的字符串，替换次数)

sub() 方法返回的结果是一个字符串：替换后的字符串

#!/usr/bin/env python
# -*- coding:utf-8 -*-
import re

if __name__ == '__main__':
    p = re.compile(r'(\w+) (\w+)')
    s = 'i say, hello world!'

    print(p.subn(r'\1 \2 hi', s))  # 输出结果：('i say hi, hello world hi!', 2)

    def func(m):
        return m.group(1).title() + ' ' + m.group(2).title()

    print(p.subn(func, s))  # 输出结果：('I Say, Hello World!', 2)

3. 使用 Match

Match对象是一次匹配的结果，包含了很多关于此次匹配的信息，可以使用Match提供的可读属性或方法来获取这些信息。

3.1 Match 对象的属性

1. string: 匹配时使用的文本。
2. re: 匹配时使用的Pattern对象。
3. pos: 文本中正则表达式开始搜索的索引。值与Pattern.match()和Pattern.seach()方法的同名参数相同。
4. endpos: 文本中正则表达式结束搜索的索引。值与Pattern.match()和Pattern.seach()方法的同名参数相同。
5. lastindex: 最后一个被捕获的分组的索引。如果没有被捕获的分组，将为None。
6. lastgroup: 最后一个被捕获的分组的别名。如果这个分组没有别名或者没有被捕获的分组，将为None。

# -*- coding: utf-8 -*-
import re

if __name__ == '__main__':
    text = 'hello world'
    p = re.compile(r'(\w+) (\w+)(?P<sign>.*)', re.DOTALL)
    match = p.match(text)
    if match:
        print("match.re:", match.re)
        print("match.string:", match.string)
        print("match.endpos:", match.endpos)
        print("match.pos:", match.pos)
        print("match.lastgroup:", match.lastgroup)
        print("match.lastindex:", match.lastindex)
        
        
# 输出结果如下：
# match.re: re.compile('(\\w+) (\\w+)(?P<sign>.*)', re.DOTALL)
# match.string: hello world
# match.endpos: 11
# match.pos: 0
# match.lastgroup: sign
# match.lastindex: 3

3.2 Match 对象的方法

1. group([group1, …]):

获得一个或多个分组截获的字符串，指定多个参数时将以元组形式返回。

group()可以使用编号也可以使用别名；

编号0代表整个匹配的子串；

不填写参数时，返回group(0)；

没有截获字符串的组返回None；

2. groups([default]):

以元组形式返回全部分组截获的字符串，相当于调用group(1,2,…last)；

default表示没有截获字符串的组以这个值替代，默认为None；

3. groupdict([default]):

返回已有别名的组的别名为键、以该组截获的子串为值的字典，没有别名的组不包含在内。default含义同上。

4. start([group]):

返回指定的组截获的子串在string中的起始索引（子串第一个字符的索引）。group默认值为0。

5. end([group]):

返回指定的组截获的子串在string中的结束索引（子串最后一个字符的索引+1）。group默认值为0。

6. span([group]):

返回(start(group), end(group))。

7. expand(template):

将匹配到的分组代入template中然后返回。template中可以使用\id或\g<id>、\g<name>引用分组，但不能使用编号0。\id与\g<id>是等价的；但\10将被认为是第10个分组，如果你想表达\1之后是字符'0'，只能使用\g<1>0。

# -*- coding: utf-8 -*-
import re

if __name__ == '__main__':
    import re
    m = re.match(r'(\w+) (\w+)(?P<sign>.*)', 'hello world!')
    print("m.group(1,2):", m.group(0, 1, 2, 3))
    print("m.groups():", m.groups())
    print("m.groupdict():", m.groupdict())
    print("m.start(2):", m.start(2))
    print("m.end(2):", m.end(2))
    print("m.span(2):", m.span(2))
    print(r"m.expand(r'\2 \1\3'):", m.expand(r'\2 \1\3'))


# 输出结果：
# m.group(1,2): ('hello world!', 'hello', 'world', '!')
# m.groups(): ('hello', 'world', '!')
# m.groupdict(): {'sign': '!'}
# m.start(2): 6
# m.end(2): 11
# m.span(2): (6, 11)
# m.expand(r'\2 \1\3'): world hello!

参考文章

python 官方文档

https://www.cnblogs.com/huxi/archive/2010/07/04/1771073.html