使用Python API更新SharePoint文件自定义属性/列的实用指南

pip install Office365-REST-Python-Client

from office365.sharepoint.client_context import ClientContext
from office365.runtime.auth.client_credential import ClientCredential
import os
import json # 假设配置存储在JSON中

# 假设您的配置存储在config.json文件中
# config.json 示例:
# {
#   "SHAREPOINT": {
#     "CLIENT_ID": "YOUR_CLIENT_ID",
#     "CLIENT_SECRET": "YOUR_CLIENT_SECRET",
#     "BASE_URL": "https://yourtenant.sharepoint.com/sites/yoursite"
#   }
# }

# 从配置文件加载认证信息
# 请确保config.json文件存在且包含正确的SharePoint配置
try:
    with open("config.json", "r") as f:
        cfg = json.load(f)

    client_id = cfg["SHAREPOINT"]["CLIENT_ID"]
    client_secret = cfg["SHAREPOINT"]["CLIENT_SECRET"]
    base_url = cfg["SHAREPOINT"]["BASE_URL"]

    # 创建认证凭据
    credentials = ClientCredential(client_id, client_secret)

    # 创建SharePoint客户端上下文
    ctx = ClientContext(base_url).with_credentials(credentials)
    print("SharePoint连接上下文已创建。")

except FileNotFoundError:
    print("错误：config.json 文件未找到。请创建并配置您的SharePoint认证信息。")
    exit()
except KeyError as e:
    print(f"错误：config.json 文件缺少必要的SharePoint配置项：{e}。")
    exit()
except Exception as e:
    print(f"创建SharePoint连接上下文时发生未知错误：{e}")
    exit()

from office365.sharepoint.client_context import ClientContext
import os

def update_sp_file_property(
    ctx: ClientContext, filepath: str, properties: dict
) -> None:
    """
    更新SharePoint文件的自定义属性（列）。

    Args:
        ctx: ClientContext 对象，已建立的SharePoint连接上下文。
        filepath: 文件的服务器相对路径，例如 "/sites/<site_name>/Shared Documents/General/folder/file.docx"。
        properties: 一个字典，键为属性的内部名称，值为要更新的新值。
    Returns:
        None
    """

    for k, v in properties.items():
        try:
            # 获取文件并访问其列表项的所有字段
            file_item = ctx.web.get_file_by_server_relative_path(filepath).listItemAllFields

            # 设置属性并提交更新
            file_item.set_property(name=k, value=v, persist_changes=True).update().execute_query()
            print(f'成功更新文件 {os.path.basename(filepath)} 的属性: "{k}" : "{v}"')
        except Exception as e:
            print(f'更新文件 {os.path.basename(filepath)} 属性 "{k}" 失败: {e}')
            # 在生产环境中，可以添加更详细的错误处理或日志记录
            # 例如：logging.error(f'Failed to update property "{k}" for file "{filepath}": {e}')

    print(f"所有指定属性更新操作已尝试完成。")

# 假设 ctx 已经按照上述“环境准备与认证”步骤成功创建

# 定义要更新的文件路径
# 请将 <sharepoint_site_name> 替换为您的SharePoint站点名称
# 将 /Shared Documents/General/path_to_file.txt 替换为您的文件的实际服务器相对路径
filepath_to_update = "/sites/<sharepoint_site_name>/Shared Documents/General/path_to_file.txt"

# 定义要更新的属性及其新值
# 确保这里的键是SharePoint列的内部名称。
# 例如，如果您的自定义列在SharePoint中显示为“项目状态”，
# 但其内部名称是“ProjectStatus”，则应使用“ProjectStatus”作为键。
properties_to_update = {
    "property1": "value1_updated",
    "property2": "value2_new",
    "CustomColumnName": "New Status Example" # 示例：更新名为“CustomColumnName”的自定义列
}

# 运行函数更新文件属性
print(f"\n开始更新文件 '{os.path.basename(filepath_to_update)}' 的属性...")
update_sp_file_property(ctx=ctx, filepath=filepath_to_update, properties=properties_to_update)
print(f"文件 '{os.path.basename(filepath_to_update)}' 的属性更新操作已完成。")