Pairs and IPairs on Table

pairs 和 ipairs 功能初探

pairs 和 ipairs 是两个标准库中的函数, 用于从 Table 数据结构中遍历元素. 简单说来, pairs 是用于遍历 Hash Table (类似于 Python dict) 中的 key, value pair 的, 类似于 Python 中的 dict.items() 方法. 而 ipairs 是用于遍历 Array Table (类似于 Python list) 中的 index 和 item 的, 类似于 Python 中的 enumerate(list) 方法.

下面是从 官方文档 中摘抄的定义.

pairs (t)

如果 t 有元方法 __pairs, 以 t 为参数调用它, 并返回其返回的前三个值.

否则, 返回三个值: next 函数, 表 t, 以及 nil. 因此以下代码:

for k, v in pairs(t) do body end

能迭代表 t 中的所有键值对.

参见函数 next 中关于迭代过程中修改表的风险.

ipairs (t)

返回三个值 (迭代函数, 表 t 以及 0 ), 如此, 以下代码:

for i,v in ipairs(t) do body end

将迭代键值对（1, t[1]), (2, t[2]), … , 直到第一个空值.

下面是一个大多数人使用这两个函数的例子

test0.lua

#!/usr/bin/env lua

--[[
pairs 和 ipairs 的常见用法.
--]]


--[[
可能的输出 (顺序可能不同):

key = a, value = 100, arg3 = nil
key = c, value = 300, arg3 = nil
key = b, value = 200, arg3 = nil
--]]
print("===== pairs =====")
local pythonDict = {a = 100, b = 200, c = 300}
for key, value in pairs(pythonDict) do
    print(string.format("key = %s, value = %s", key, value))
end

--[[
输出 (Lua 中 index 是从 1 开始的):

index = 1, value = a
index = 2, value = b
index = 3, value = c
--]]
print("===== ipairs =====")
local pythonList = {"a", "b", "c"}
for index, value in ipairs(pythonList) do
    print(string.format("index = %s, value = %s", index, value))
end

import subprocess

subprocess.run(["lua", "test0.lua"]);

===== pairs =====
key = b, value = 200
key = c, value = 300
key = a, value = 100
===== ipairs =====
index = 1, value = a
index = 2, value = b
index = 3, value = c

Example 1

从这个例子可以看出, 对于 key 不是从 1 开始的整数的 Hash Table, ipairs 没有效果.

test1.lua

#!/usr/bin/env lua

--[[
pairs:

- 用于遍历表中的所有键值对
- 遍历顺序不确定
- 可以处理任何类型的键（包括字符串、数字等）

ipairs:

- 用于遍历数组部分（即使用连续整数索引的部分）
- 按照索引的数字顺序遍历
- 遇到 nil 值或非整数键时停止
--]]

local pythonDict = {
    a = 100,
    b = 200,
    c = 300,
}

--[[
可能的输出 (顺序可能不同):

key = a, value = 100, arg3 = nil
key = c, value = 300, arg3 = nil
key = b, value = 200, arg3 = nil
--]]

print("===== pairs =====")
for arg1, arg2, arg3 in pairs(pythonDict) do
    print(string.format("key = %s, value = %s, arg3 = %s", arg1, arg2, arg3))
end

--[[
输出: (无输出)
解释: 由于这个表没有使用整数索引, ipairs 不会遍历任何元素.
--]]
print("===== ipairs =====")
for arg1, arg2, arg3 in ipairs(pythonDict) do
    print(string.format("key = %s, value = %s, arg3 = %s", arg1, arg2, arg3))
end

subprocess.run(["lua", "test1.lua"]);

===== pairs =====
key = a, value = 100, arg3 = nil
key = b, value = 200, arg3 = nil
key = c, value = 300, arg3 = nil
===== ipairs =====

Example 2

从这个例子可以看出, 对于 key 不是从 1 开始的整数的 Hash Table, ipairs 没有效果. 只要数字不是 1, 2, 3, …, 就不可以. 因为它本质上是返回 (1, table[1]), (2, table[2]), … 直到碰到第一个 nil 为止. 在这种情况下第一个就是 nil, 所以什么也没有返回.

test2.lua

#!/usr/bin/env lua

local pythonDict = {
    [100] = "a",
    [200] = "b",
    [300] = "3",
}

--[[
输出:

key = 300, value = 3, arg3 = nil
key = 100, value = a, arg3 = nil
key = 200, value = b, arg3 = nil
--]]
print("===== pairs =====")
for arg1, arg2, arg3 in pairs(pythonDict) do
    print(string.format("key = %s, value = %s, arg3 = %s", arg1, arg2, arg3))
end

--[[
输出: (无输出)
解释: 由于这个表没有使用整数索引, ipairs 不会遍历任何元素.
--]]
print("===== ipairs =====")
for arg1, arg2, arg3 in ipairs(pythonDict) do
    print(string.format("key = %s, value = %s, arg3 = %s", arg1, arg2, arg3))
end

subprocess.run(["lua", "test2.lua"]);

===== pairs =====
key = 300, value = 3, arg3 = nil
key = 100, value = a, arg3 = nil
key = 200, value = b, arg3 = nil
===== ipairs =====

Example 3

对于 key 是从整数开始的 Hash Table, ipairs 是有效果的.

test3.lua

#!/usr/bin/env lua

local pythonDict = {
    [1] = "a",
    [2] = "b",
    [3] = "c",
}

print("===== pairs =====")
for arg1, arg2, arg3 in pairs(pythonDict) do
    print(string.format("key = %s, value = %s, arg3 = %s", arg1, arg2, arg3))
end

--[[
由于该表采用了整数索引, 所以可以用 ipairs. 输出:

key = 1, value = a, arg3 = nil
key = 2, value = b, arg3 = nil
key = 3, value = c, arg3 = nil
--]]
print("===== ipairs =====")
for arg1, arg2, arg3 in ipairs(pythonDict) do
    print(string.format("key = %s, value = %s, arg3 = %s", arg1, arg2, arg3))
end

subprocess.run(["lua", "test3.lua"]);

===== pairs =====
key = 3, value = c, arg3 = nil
key = 1, value = a, arg3 = nil
key = 2, value = b, arg3 = nil
===== ipairs =====
key = 1, value = a, arg3 = nil
key = 2, value = b, arg3 = nil
key = 3, value = c, arg3 = nil

Example 4

从这个例子可以看出, 对于 Array Table, pairs 返回的 key 会是 1, 2, 3, …

test4.lua

#!/usr/bin/env lua

local pythonList = {
    "a",
    "b",
    "c"
}

--[[
输出:

key = 1, value = a, arg3 = nil
key = 2, value = b, arg3 = nil
key = 3, value = c, arg3 = nil
--]]
print("===== pairs =====")
for arg1, arg2, arg3 in pairs(pythonList) do
    print(string.format("key = %s, value = %s, arg3 = %s", arg1, arg2, arg3))
end

--[[
输出:

key = 1, value = a, arg3 = nil
key = 2, value = b, arg3 = nil
key = 3, value = c, arg3 = nil
--]]
print("===== ipairs =====")
for arg1, arg2, arg3 in ipairs(pythonList) do
    print(string.format("key = %s, value = %s, arg3 = %s", arg1, arg2, arg3))
end

--[[
对于列表, 输出就是 index 和 value, 跟 python 中的 enumerate 函数类似. 输出:

key = 1, value = a
key = 2, value = b
key = 3, value = c
--]]
print("===== ipairs =====")
for arg1, arg2 in ipairs(pythonList) do
    print(string.format("key = %s, value = %s", arg1, arg2))
end

subprocess.run(["lua", "test4.lua"]);

===== pairs =====
key = 1, value = a, arg3 = nil
key = 2, value = b, arg3 = nil
key = 3, value = c, arg3 = nil
===== ipairs =====
key = 1, value = a, arg3 = nil
key = 2, value = b, arg3 = nil
key = 3, value = c, arg3 = nil
===== ipairs =====
key = 1, value = a
key = 2, value = b
key = 3, value = c

Example 5

从这个例子可以看出, 对于 Array Table, pairs 返回的 key 会是 1, 2, 3, …

test5.lua

#!/usr/bin/env lua

local pythonList = {
    100,
    200,
    300
}

--[[
输出:

key = 1, value = 100, arg3 = nil
key = 2, value = 200, arg3 = nil
key = 3, value = 300, arg3 = nil
--]]
print("===== pairs =====")
for arg1, arg2, arg3 in pairs(pythonList) do
    print(string.format("key = %s, value = %s, arg3 = %s", arg1, arg2, arg3))
end

--[[
输出:

key = 1, value = 100, arg3 = nil
key = 2, value = 200, arg3 = nil
key = 3, value = 300, arg3 = nil
--]]
print("===== ipairs =====")
for arg1, arg2, arg3 in ipairs(pythonList) do
    print(string.format("key = %s, value = %s, arg3 = %s", arg1, arg2, arg3))
end

subprocess.run(["lua", "test5.lua"]);

===== pairs =====
key = 1, value = 100, arg3 = nil
key = 2, value = 200, arg3 = nil
key = 3, value = 300, arg3 = nil
===== ipairs =====
key = 1, value = 100, arg3 = nil
key = 2, value = 200, arg3 = nil
key = 3, value = 300, arg3 = nil

Example 6

test6.lua

#!/usr/bin/env lua

local pythonList = {
    1,
    2,
    3
}

--[[
输出:

key = 1, value = 1, arg3 = nil
key = 2, value = 2, arg3 = nil
key = 3, value = 3, arg3 = nil
--]]
print("===== pairs =====")
for arg1, arg2, arg3 in pairs(pythonList) do
    print(string.format("key = %s, value = %s, arg3 = %s", arg1, arg2, arg3))
end

--[[
输出:

key = 1, value = 1, arg3 = nil
key = 2, value = 2, arg3 = nil
key = 3, value = 3, arg3 = nil
--]]
print("===== ipairs =====")
for arg1, arg2, arg3 in ipairs(pythonList) do
    print(string.format("key = %s, value = %s, arg3 = %s", arg1, arg2, arg3))
end

subprocess.run(["lua", "test6.lua"]);

===== pairs =====
key = 1, value = 1, arg3 = nil
key = 2, value = 2, arg3 = nil
key = 3, value = 3, arg3 = nil
===== ipairs =====
key = 1, value = 1, arg3 = nil
key = 2, value = 2, arg3 = nil
key = 3, value = 3, arg3 = nil