Xpath的使用

XPath 的全称是 XML Path Language,即 XML 路径语言,用来在 XML 文档中查找信息。它虽然最初是用来搜寻 XML 文档的,但同样适用于 HTML 文档的搜索。

所以在做爬虫时,我们完全可以使用 XPath 实现相应的信息抽取。本节我们就介绍一下 XPath 的基本用法。

XPath概览

XPath 的选择功能十分强大,它提供了非常简洁明了的路径选择表达式。另外,它还提供了 100 多个内建函数,用于字符串、数值时间的匹配以及节点、序列的处理等。几乎所有我们想要定位的节点,都可以用 XPath 选择。

XPath 于 1999 年 11 月 16 日成为 W3C 标准,它被设计出来,供 XSLI、XPointer 以及其他 XML 解析软件使用。

XPath常用规则

表 3-1 列举了 XPath 的几个常用规则。

Table 1. 表 3-1 XPath的常用规则
表达式 描述

nodename

选取此节点的所有子节点

/

从当前节点选取直接子节点

//

从当前节点选取子孙节点

.

选取当前节点

..

选取当前节点的父节点

@

选取属性

这里列出了 XPath 的一个常用匹配规则,如下:

//title[@lang='eng']

它代表选择所有名称为 title,同时属性 lang 的值为 eng 的节点。

后面会通过 Python 的 lxml 库,利用 XPath 对 HTML 进行解析。

准备工作

使用 lxml 库之前,首先要确保其已安装好。

可以使用 pip3 来安装:

pip3 install lxml

更详细的安装说明可以参考: https://setup.scrape.center/lxml

安装完成后,就可以进入接下来的学习了。

实例引入

下面通过实例感受一下使用 XPath 对网页进行解析的过程,相关代码如下:

from lxml import etree
text = '''
<div>
    <ul>
         <li class="item-0"><a href="link1.html">first item</a></li>
         <li class="item-1"><a href="link2.html">second item</a></li>
         <li class="item-inactive"><a href="link3.html">third item</a></li>
         <li class="item-1"><a href="link4.html">fourth item</a></li>
         <li class="item-0"><a href="link5.html">fifth item</a>
     </ul>
 </div>
'''
html = etree.HTML(text)
result = etree.tostring(html)
print(result.decode('utf-8'))

这里首先导入 lxml 库的 etree 模块,然后声明了一段 HTML 文本,接着调用 HTML 类进行初始化,这样就成功构造了一个 XPath 解析对象。此处需要注意一点,HTML 文本中的最后一个 li 节点是没有闭合的,而 etree 模块可以自动修正 HTML 文本。

之后调用 tostring 方法即可输出修正后的 HTML 代码,但是结果是 bytes 类型。于是利用 decode 方法将其转换成 str 类型,结果如下:

<html><body><div>
    <ul>
         <li class="item-0"><a href="link1.html">first item</a></li>
         <li class="item-1"><a href="link2.html">second item</a></li>
         <li class="item-inactive"><a href="link3.html">third item</a></li>
         <li class="item-1"><a href="link4.html">fourth item</a></li>
         <li class="item-0"><a href="link5.html">fifth item</a>
     </ul>
 </div></body></html>

可以看到,经过处理之后的 li 节点标签得以补全,并且自动添加了 bodyhtml 节点。

另外,也可以不声明,直接读取文本文件进行解析,实例如下:

from lxml import etree

html = etree.parse('./test.html', etree.HTMLParser())
result = etree.tostring(html)
print(result.decode('utf-8'))

其中 test.html 的内容就是上面例子中的 HTML 代码,内容如下:

<html>
<body>
  <div>
    <ul>
      <li class="item-0"><a href="link1.html">first item</a></li>
      <li class="item-1"><a href="link2.html">second item</a></li>
      <li class="item-inactive"><a href="link3.html">third item</a></li>
      <li class="item-1"><a href="link4.html">fourth item</a></li>
      <li class="item-0"><a href="link5.html">fifth item</a></li>
    </ul>
  </div>
</body>
</html>

这次的输出结果略有不同,多了一个 DOCTYPE 声明,不过对解析无任何影响,结果如下:

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<body>
  <div>
    <ul>
      <li class="item-0"><a href="link1.html">first item</a></li>
      <li class="item-1"><a href="link2.html">second item</a></li>
      <li class="item-inactive"><a href="link3.html">third item</a></li>
      <li class="item-1"><a href="link4.html">fourth item</a></li>
      <li class="item-0"><a href="link5.html">fifth item</a></li>
    </ul>
  </div>
</body>
</html>

所有节点

我们一般会用以 // 开头的 XPath 规则,来选取所有符合要求的节点。这里还是以第一个实例中的 HTML 文本为例,选取其中所有节点,实现代码如下:

from lxml import etree
html = etree.parse('./test.html', etree.HTMLParser())
result = html.xpath('//*')
print(result)

运行结果如下:

[<Element html at 0x19335dca800>, <Element body at 0x19337e2c340>, <Element div at 0x19337e2c380>, <Element ul at 0x19337e2c300>, <Element li at 0x19337e2c3c0>, <Element a at 0x19337e2c440>, <Element li at 0x19337e2c480>, <Element a at 0x19337e2c4c0>, <Element li at 0x19337e2c500>, <Element a at 0x19337e2c400>, <Element li at 0x19337e2c540>, <Element a at 0x19337e2c580>, <Element li at 0x19337e2c5c0>, <Element a at 0x19337e2c600>]

这里使用 * 代表匹配所有节点,也就是获取整个 HTML 文本中的所有节点。从运行结果可以看到,返回形式是一个列表,其中每个元素是 Element 类型,类型后面跟着节点的名称,如 htmlbodydivullia 等,所有节点都包含在了列表中。

当然,此处匹配也可以指定节点名称。例如想获取所有 li 节点,实例如下:

from lxml import etree

html = etree.parse('./test.html', etree.HTMLParser())
result = html.xpath('//li')
print(result)
print(result[0])

这里选取所有 li 节点,可以使用 //,然后直接加上节点名称,调用时使用 Xpath 方法即可。

运行结果如下:

[<Element li at 0x17bea31c300>, <Element li at 0x17bea31c340>, <Element li at 0x17bea31c2c0>, <Element li at 0x17bea31c380>, <Element li at 0x17bea31c3c0>]
<Element li at 0x17bea31c300>

可以看到,提取结果也是一个列表,其中每个元素都是 Element 类型。要是想取出其中一个对象,可以直接用中括号加索引获取,如 [0]

子节点

通过 /// 即可查找元素的子节点或子孙节点。假如现在想选择 li 节点的所有直接子节点 a,则可以这样实现:

from lxml import etree

html = etree.parse('./test.html', etree.HTMLParser())
result = html.xpath('//li/a')
print(result)

这里通过追加 /a 的方式,选择了所有 li 节点的所有直接子节点 a。其中 //li 用于选中所有 li 节点,/a 用于选中 li 节点的所有直接子节点 a

运行结果如下:

[<Element a at 0x2916cfbc340>, <Element a at 0x2916cfbc380>, <Element a at 0x2916cfbc300>, <Element a at 0x2916cfbc3c0>, <Element a at 0x2916cfbc400>]

上面的 / 用于选取节点的直接子节点,如果要获取节点的所有子孙节点,可以使用 //。例如,要获取 ul 节点下的所有子孙节点 a,可以这样实现:

from lxml import etree

html = etree.parse('./test.html', etree.HTMLParser())
result = html.xpath('//ul//a')
print(result)

运行结果是相同的。

但是如果这里用 //ul/a,就无法获取任何结果了。因为 / 用于获取直接子节点,而 ul 节点下没有直接的 a 子节点,只有 li 节点,所以无法获取任何匹配结果,代码如下:

from lxml import etree

html = etree.parse('./test.html', etree.HTMLParser())
result = html.xpath('//ul/a')
print(result)

运行结果如下:

[]

因此这里要注意 /// 的区别,前者用于获取直接子节点,后者用于获取子孙节点。

父节点

通过连续的 /// 可以查找子节点或子孙节点,那么假如知道了子节点,怎样查找父节点呢?这可以用实现。

例如,首先选中 href 属性为 link4.htmla 节点,然后获取其父节点,再获取父节点的 class 属性,相关代码如下:

from lxml import etree

html = etree.parse('./test.html', etree.HTMLParser())
result = html.xpath('//a[@href="link4.html"]/../@class')
print(result)

运行结果如下:

['item-1']

检查一下结果发现,这正是我们获取的目标 li 节点的 class 属性。

也可以通过 parent:: 获取父节点,代码如下:

from lxml import etree

html = etree.parse('./test.html', etree.HTMLParser())
result = html.xpath('//a[@href="link4.html"]/parent::*/@class')
print(result)

属性匹配

在选取节点的时候,还可以使用 @ 符号实现属性过滤。例如,要选取 class 属性为 item-0li 节点,可以这样实现:

from lxml import etree

html = etree.parse('./test.html', etree.HTMLParser())
result = html.xpath('//li[@class="item-0"]')
print(result)

这里通过加入 [@class="item-0"],限制了节点的 class 属性为 item-0。HTML 文本中符合这个条件的 li 节点有两个,所以结果应该返回两个元素。结果如下:

[<Element li at 0x1ed2e9dc240>, <Element li at 0x1ed2e9dc1c0>]

可见,匹配结果正是两个,至于是不是正确的那两个,后面再验证。

文本获取

用 XPath 中的 text 方法可以获取节点中的文本,接下来尝试获取前面 li 节点中的文本,相关代码如下:

from lxml import etree

html = etree.parse('./test.html', etree.HTMLParser())
result = html.xpath('//li[@class="item-0"]/text()')
print(result)

运行结果如下:

['\n    ']

奇怪的是,我们没有获取任何文本,只获取了一个换行符,这是为什么呢?因为 xpathtext 方法的前面是 /,而 / 的含义是选取直接子节点,很明显 li 的直接子节点都是 a 节点,文本都是在 a 节点内部的,所以这里匹配到的结果就是被修正的 li 节点内部的换行符,因为自动修正的 li 节点的尾标签换行了。

即选中的是这两个节点:

<li class="item-0"><a href="link1.html">first item</a></li>
<li class="item-1"><a href="link2.html">second item</a></li>

其中一个节点因为自动修正,li 节点的尾标签在添加的时候换行了,所以提取文本得到的唯一结果就是 li 节点的尾标签和 a 节点的尾标签之间的换行符。

因此,如果想获取 li 节点内部的文本,就有两种方式,一种是先选取 a 节点再获取文本,另一种是使用 //。接下来,我们看下两种方式的区别。

先选取 a 节点,再获取文本的代码如下:

from lxml import etree

html = etree.parse('./test.html', etree.HTMLParser())
result = html.xpath('//li[@class="item-0"]/a/text()')
print(result)

运行结果如下:

['first item', 'fifth item']

可以看到,这里有两个返回值,内容都是 class 属性为 item-0li 节点的文本,这也印证了前面属性匹配的结果是正确的。

这种方式下,我们是逐层选取的,先选取 li 节点,然后利用 / 选取其直接子节点 a,再选取节点 a 的文本,得到的两个结果恰好是符合我们预期的。

再来看一下使用 // 能够获取什么样的结果,代码如下:

from lxml import etree

html = etree.parse('./test.html', etree.HTMLParser())
result = html.xpath('//li[@class="item-0"]//text()')
print(result)

运行结果如下:

['first item', 'fifth item', '\n     ']

不出所料,这里的返回结果是三个。可想而知,这里选取的是所有子孙节点的文本,其中前两个是 li 的子节点 a 内部的文本,另外一个是最后一个 li 节点内部的文本,即换行符。

由此,要想获取子孙节点内部的所有文本,可以直接使用 //text 方法的方式,这样能够保证获取最全面的文本信息,但是可能会夹杂一些换行符等特殊字符。如果想获取某些特定子孙节点下的所有文本,则可以先选取特定的子孙节点,再调用 text 方法获取其内部的文本,这样可以保证获取的结果是整洁的。

属性获取

我们已经可以用 text 方法获取节点内部文本,那么节点属性该怎样获取呢?其实依然可以用 @ 符号。例如,通过如下代码获取所有 li 节点下所有 a 节点的 href 属性:

from lxml import etree

html = etree.parse('./test.html', etree.HTMLParser())
result = html.xpath('//li/a/@href')
print(result)

这里通过 @href 获取节点的 href 属性。注意,此处和属性匹配的方法不同,属性匹配是用中括号加属性名和值来限定某个属性,如 [@href="link1.html"],此处的 @href 是指获取节点的某个属性二者需要做好区分。

运行结果如下:

['link1.html', 'link2.html', 'link3.html', 'link4.html', 'link5.html']

可以看到,我们成功获取了所有 li 节点下 a 节点的 href 属性,并以列表形式返回了它们。

属性多值匹配

有时候,某些节点的某个属性可能有多个值,例如:

from lxml import etree

text = '''
<li class="li li-first"><a href="link.html">first item</a></li>
'''

html = etree.HTML(text)
result = html.xpath('//li[@class="li"]/a/text()')
print(result)

这里 HTML 文本中 li 节点的 class 属性就有两个值:lili-first。此时如果还用之前的属性匹配获取节点,就无法进行了,运行结果如下:

[]

这种情况需要用到 contains 方法,于是代码可以改写如下:

from lxml import etree

text = '''
<li class="li li-first"><a href="link.html">first item</a></li>
'''

html = etree.HTML(text)
result = html.xpath('//li[contains(@class, "li")]/a/text()')
print(result)

上面使用了 contains 方法,给其第一个参数传入属性名称,第二个参数传入属性值,只要传入的属性包含传入的属性值,就可以完成匹配了。

此时运行结果如下:

['first item']

contains 方法经常在某个节点的某个属性有多个值时用到。

多属性匹配

我们还可能遇到一种情况,就是根据多个属性确定一个节点,这时需要同时匹配多个属性。运算符 and 用于连接多个属性,实例如下:

from lxml import etree

text = '''
<li class="li li-first" name="item"><a href="link.html">first item</a></li>
'''

html = etree.HTML(text)
result = html.xpath('//li[contains(@class, "li") and @name="item"]/a/     text()')
print(result)

这里的 li 节点又增加了一个属性 name。因此要确定 li 节点,需要同时考察 classname 属性一个条件是 class 属性里面包含 li 字符串,另一个条件是 name 属性为 item 字符串,这二者同时得到满足,才是 li 节点。classname 属性需要用 and 运算符相连,相连之后置于中括号内进行条件筛选。运行结果如下:

['first item']

这里的 and 其实是 XPath 中的运算符。除了它,还有很多其他运算符,如 ormod 等,在此总结为表 3-2。

Table 2. 表 3-2 运算符及其介绍
运 算 符 描 述 实 例 返 回 值

or

age=19 or age=20

如果 age 是 19, 则返回 true。如果 age 是 21, 则返回 false

and

age>19 and age<21

如果 age 是 20, 则返回 true。如果 age 是 18, 则返回 false

mod

计算除法的余数

5 mod 2

1

|

计算两个节点集

//book|//cd

返回所有拥有 book 和 cd 元素的节点集

+

加法

6 + 4

10

-

减法

6 - 4

2

*

乘法

6 * 4

24

div

除法

8 div 4

2

=

等于

age=19

如果 age 是 19, 则返回 true。如果 age 是 20, 则返回 false

!=

不等于

age!=19

如果 age 是 18, 则返回 true。如果 age 是 19, 则返回 false

<

小于

age<19

如果 age 是 18, 则返回 true。如果 age 是 19, 则返回 false

<=

小于或等于

<=19

如果 age 是 19, 则返回 true。如果 age 是 20, 则返回 false

>

大于

age>19

如果 age 是 20, 则返回 true。如果 age 是 19, 则返回 false

>=

大于或等于

age>=19

如果 age 是 19, 则返回 true。如果 age 是 18, 则返回 false

按序选择

在选择节点时,某些属性可能同时匹配了多个节点,但我们只想要其中的某一个,如第二个或者最后一个,这时该怎么办呢?

可以使用往中括号中传入索引的方法获取特定次序的节点,实例如下:

from lxml import etree

text = '''
<div>
  <ul>
    <li class="item-0"><a href="link1.html">first item</a></li>
    <li class="item-1"><a href="link2.html">second item</a></li>
    <li class="item-inactive"><a href="link3.html">third item</a></li>
    <li class="item-1"><a href="link4.html">fourth item</a></li>
    <li class="item-0"><a href="link5.html">fifth item</a></li>
  </ul>
</div>
'''

html = etree.HTML(text)
result = html.xpath('//li[1]/a/text()')
print(result)
result = html.xpath('//li[last()]/a/text()')
print(result)
result = html.xpath('//li[position()<3]/a/text()')
print(result)
result = html.xpath('//li[last()-2]/a/text()')
print(result)

上述代码中,第一次选择时选取了第一个 li 节点,往中括号中传入数字 1 即可实现。注意,这里和写代码不同,序号以 1 开头,而非 0。

第二次选择时,选取了最后一个 li 节点,在中括号中调用 last 方法即可实现。

第三次选择时,选取了位置小于 3 的 li 节点,也就是位置序号为 1 和 2 的节点,得到的结果就是前两个 li 节点。

第四次选择时,选取了倒数第三个 li 节点,在中括号中调用 last 方法再减去 2 即可实现。因为 last 方法代表最后一个,在此基础上减 2 得到的就是倒数第三个。

运行结果如下:

['first item']
['fifth item']
['first item','second item']
['third item']

在这个实例中,我们使用了 lastposition 等方法。XPath 提供了 100 多个方法,包括存取、数值、字符串、逻辑、节点、序列等处理功能。

节点轴选择

XPath 提供了很多节点轴的选择方法,包括获取子元素、兄弟元素、父元素、祖先元素等,实例如下:

from lxml import etree

text = '''
<div>
  <ul>
    <li class="item-0"><a href="link1.html"><span>first item</span></a></li>
    <li class="item-1"><a href="link2.html">second item</a></li>
    <li class="item-inactive"><a href="link3.html">third item</a></li>
    <li class="item-1"><a href="link4.html">fourth item</a></li>
    <li class="item-0"><a href="link5.html">fifth item</a></li>
  </ul>
</div>
'''

html = etree.HTML(text)
result = html.xpath('//li[1]/ancestor::*')
print(result)
result = html.xpath('//li[1]/ancestor::div')
print(result)
result = html.xpath('//li[1]/attribute::*')
print(result)
result = html.xpath('//li[1]/child::a[@href="link1.html"]')
print(result)
result = html.xpath('//li[1]/descendant::span')
print(result)
result = html.xpath('//li[1]/following::*[2]')
print(result)
result = html.xpath('//li[1]/following-sibling::*')
print(result)

运行结果如下:

[<Element html at 0x203ba020980>, <Element body at 0x203bbd0c280>, <Element div at 0x203bbd0c2c0>, <Element ul at 0x203bbd0c240>]
[<Element div at 0x203bbd0c2c0>]
['item-0']
[<Element a at 0x203bbd0c240>]
[<Element span at 0x203bbd0c2c0>]
[<Element a at 0x203bbd0c280>]
[<Element li at 0x203bbd0c040>, <Element li at 0x203bbd0c200>, <Element li at 0x203bbd0c340>, <Element li at 0x203bbd0c380>]

上述代码中第一次选择时,调用了 ancestor 轴,可以获取所有祖先节点。其后需要跟两个冒号,然后是节点的选择器,这里我们直接使用 *,表示匹配所有节点,因此相应返回结果是第一个 li 节点的所有祖先节点,包括 htmlbodydivul

第二次选择时,又加了限定条件,这次是在冒号后面加了 div,于是得到的结果就只有 div 这个祖先节点了。

第三次选择时,调用了 attribute 轴,可以获取所有属性值,其后跟的选择器还是 *,代表获取节点的所有属性,返回值就是 li 节点的所有属性值。

第四次选择时,调用了 child 轴,可以获取所有直接子节点。这里我们文加了限定条件,选取 href 属性为 link1.htmla 节点。

第五次选择时,调用了 descendant 轴,可以获取所有子孙节点。这里我们又加了限定条件一一获取 span 节点,所以返回结果只包含 span 节点,不包含 a 节点。

第六次选择时,调用了 following 轴,可以获取当前节点之后的所有节点。这里我们虽然使用的是 * 匹配,但又加了索引选择,所以只获取了第二个后续节点。

第七次选择时,调用了 following-sibling 轴,可以获取当前节点之后的所有同级节点。这里我们使用 * 匹配,所以获取了所有的后续同级节点。

总结

到现在为止,我们把可能用到的 XPath 选择器基本介绍完了。XPath 功能非常强大,内置函数非常多,熟练使用之后,可以大大提升提取 HTML 信息的效率。