Python正则分组调用group/groups方法触发IndexError报错排查

问题背景 #

开发电话号码提取功能，预期匹配格式为+1 (555) 555-5555的手机号，特定场景下调用re.group()、re.groups()方法时，解释器抛出IndexError: Replacement index 1 out of range for positional args tuple错误。
已知现象：

• 直接打印self.pmo.groups()可正常输出匹配结果
• 使用str.format()拼接groups()返回值时直接报错
• 误以为逐次传入group(1)到group(4)的拼接写法也会触发错误

相关代码 #

预编译正则规则 #

self.phoneRegex = re.compile(r'(\+\d) (\(\d\d\d\)) (\d\d\d)(\d\d\d\d)')

触发异常的业务代码 #

for cell in self.cells:
    if '+1' in cell.text:
        print(self.pmo.groups()) # 可正常运行
        print("{} {} {}-{}".format(self.pmo.groups())) # 报错
        print("{} {} {}-{}".format(self.pmo.group(1), self.pmo.group(2),self.pmo.group(3), self.pmo.group(4))) # 实际未执行到
        if isinstance(self.cursor(row=self.data['lst_row'], column=self.telCol).value, type(None)):
            self.cursor(row=self.data['lst_row'], column=self.telCol).value = "{} {};".format("{} {} {}-{}".format(self.pmo.group(2), self.pmo.group(2),self.pmo.group(3), self.pmo.group(4)))

完整报错回溯 #

Traceback (most recent call last):
  File "F:\Documents\Programs\Python\E45 Contact Info Puller\main.py", line 289, in run
    print("{} {} {}-{}".format(self.pmo.groups()))
IndexError: Replacement index 1 out of range for positional args tuple

错误原因 #

• 核心报错点是第一处format调用：self.pmo.groups()返回值是包含4个匹配分组的元组，直接传入format时相当于只传了1个位置参数（整个元组对象），但格式化字符串里写了4个{}占位符，当format尝试读取第2个位置参数时找不到对应值，直接触发索引越界。
• 误以为逐次传入group的写法也报错，实际是代码运行到上一行format时就已经中断，根本没有执行到下一行print，该行写法本身没有语法问题。
• 现有正则存在逻辑缺陷：第三组和第四组的匹配规则之间没有写横杠-的匹配，遇到标准格式+1 (555) 555-5555（中间带横杠）的号码会匹配失败。
• 嵌套format的传参存在笔误：内层format的前两个参数都传了self.pmo.group(2)，拼接出来的号码格式错误。

修复方案 #

• 修正format传参方式，对groups()返回的元组加*做解包，将元组拆分为4个独立的位置参数传入format：

  # 错误写法
  # print("{} {} {}-{}".format(self.pmo.groups()))
  # 正确写法
  print("{} {} {}-{}".format(*self.pmo.groups()))
  

• 修正正则规则，补上横杠匹配，适配标准格式的电话号码：

  # 原正则漏了横杠匹配
  # self.phoneRegex = re.compile(r'(\+\d) (\(\d\d\d\)) (\d\d\d)(\d\d\d\d)')
  # 修正后正则，同时用\d{3}简化连续数字的写法
  self.phoneRegex = re.compile(r'(\+\d) (\(\d{3}\)) (\d{3})-(\d{4})')
  

• 增加匹配成功判断，修正嵌套format的传参笔误，优化代码逻辑：

  for cell in self.cells:
      if '+1' in cell.text:
          # 每次循环重新做匹配，避免pmo是历史匹配结果导致数据错误
          self.pmo = self.phoneRegex.search(cell.text)
          # 匹配失败直接跳过，避免调用group方法抛异常
          if notself.pmo:
              continue
          print(self.pmo.groups())
          print("{} {} {}-{}".format(*self.pmo.groups()))
          # 逐次传group的写法本身可以正常运行
          print("{} {} {}-{}".format(self.pmo.group(1), self.pmo.group(2),self.pmo.group(3), self.pmo.group(4)))
          target_cell = self.cursor(row=self.data['lst_row'], column=self.telCol)
          if target_cell.value is None:
              # 修正重复传group(2)的笔误
              formatted_phone = "{} {} {}-{}".format(self.pmo.group(1), self.pmo.group(2), self.pmo.group(3), self.pmo.group(4))
              target_cell.value = f"{formatted_phone};"
  

内容的提问来源于stack exchange，提问作者Xlaits