使用shareplum更新Office365 SharePoint列表项失败问题排查

问题描述 #

基于shareplum库开发的Python脚本已稳定运行数月，核心逻辑是调用UpdateListItems(kind = 'Update')方法更新SharePoint列表的多个列字段，近期功能突发异常：

• 执行更新操作时无任何报错抛出，但目标列表项的修改内容未实际生效
• 测试确认新建列表项功能可正常运行，仅更新已有列表项的操作失效
• 使用环境为Office365版本的SharePoint

出现异常的列表规模较大：包含超过500个列表项、100余个列，列表项最大ID为1050。在其他规模更小的列表上运行完全相同的代码，更新操作可正常执行，因此判断问题与该特定列表相关。由于操作过程无显式报错，暂无法定位问题来源。

复现代码 #

from shareplum import Site
from shareplum import Office365
    
authcookie = Office365('https://XXX.sharepoint.com', username= XXX, password= XXX).GetCookies()
site = Site('https://XXX.sharepoint.com/sites/XXX', authcookie=authcookie)
list_ = site.List('TestList')

my_data = [{'ID': '3', 'Title': 'TestTitle'}]
list_.UpdateListItems(data=my_data, kind='Update')

问题补充 #

打印接口返回的原始响应结果后，得到错误信息：

'0x80070057', 'Bad parameter passed to Web Server Extensions. Check the information you entered and try again.'

目前已改用Office365-REST-Python-Client库实现了列表项更新功能，但仍希望明确shareplum出现该问题的具体原因。

这个问题是SharePlum库本身的固有缺陷叠加SharePoint Online接口规则变化导致的，和业务代码逻辑无关，具体触发逻辑：

• 大列表字段触发XML拼接bug
  SharePlum调用的是SharePoint旧版SOAP接口Lists.asmx，执行更新操作前会自动拉取目标列表的全量字段schema做字段名转义、匹配。当列表字段数超过100个时，库内部拼接SOAP请求XML的逻辑会出现属性截断、特殊字符转义错位，最终传给接口的请求体包含非法格式参数，就会返回0x80070057参数错误。
  新建列表项的逻辑不会触发全量字段schema遍历校验，只有更新操作走这个流程，所以新建功能正常、更新失效；小列表字段总数少，XML拼接不会触发截断问题，因此小列表上相同代码可以正常运行。
• SharePoint Online的1000项阈值校验
  当列表最大项ID超过1000后，SharePoint Online会收紧对旧版SOAP接口的参数校验，拒绝携带冗余字段元数据的更新请求，SharePlum自动拼接的无关字段属性刚好命中这个校验规则。
• 无显式报错的原因
  PyPI上发布的最后一版SharePlum已经停更多年，没有实现SOAP响应内的错误码解析、抛出逻辑，只会静默返回接口响应，所以表面看代码执行无异常，实际更新请求已经被服务端拒绝。

若要继续使用SharePlum的修复方法 #

• 初始化List对象时主动指定fields参数，只传入本次更新需要用到的字段，禁止库自动拉取全量字段schema：

  list_ = site.List('TestList', fields=['ID', 'Title'])
  

• 控制单次更新的条目数，单批提交不要超过50条，分批更新避免请求体过大触发校验。
• 替换为社区后续维护的SharePlum衍生版本，官方原版已经不修复大列表相关的兼容问题。

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