使用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

def get_client_context(client_id: str, client_secret: str, base_url: str) -> ClientContext:
    """
    创建并返回SharePoint客户端上下文。
    """
    credentials = ClientCredential(client_id, client_secret)
    ctx = ClientContext(base_url).with_credentials(credentials)
    return ctx

# 示例配置（实际应用中通常从配置文件加载）
# client_id = "YOUR_CLIENT_ID"
# client_secret = "YOUR_CLIENT_SECRET"
# base_url = "https://yourcompany.sharepoint.com/sites/yoursite"

# ctx = get_client_context(client_id, client_secret, base_url)

from office365.sharepoint.client_context import ClientContext
from office365.runtime.auth.client_credential import ClientCredential
import os

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

    Args:
        ctx: ClientContext 对象，已认证的SharePoint客户端上下文。
        filepath: 文件的服务器相对路径，例如 "/sites/mysite/Shared Documents/General/path_to_file.docx"。
        properties: 包含要更新的属性名称和值的字典。
                    属性名称应与SharePoint中自定义列的内部名称匹配。
    Returns:
        None
    """
    try:
        # 获取文件对象，并进而获取其对应的列表项所有字段
        # 这允许我们修改与文件关联的元数据
        file_item = ctx.web.get_file_by_server_relative_path(filepath).listItemAllFields

        # 遍历所有待更新的属性，并设置到文件列表项中
        for k, v in properties.items():
            file_item.set_property(name=k, value=v, persist_changes=True)
            print(f'准备为文件 "{os.path.basename(filepath)}" 设置属性: "{k}" = "{v}"')

        # 一次性提交所有属性更改
        file_item.update().execute_query()
        print(f'成功更新文件 "{os.path.basename(filepath)}" 的所有指定属性。')

    except Exception as e:
        print(f"更新文件属性时发生错误 '{filepath}': {e}")

# 假设 cfg 是一个字典或配置对象，包含SharePoint认证信息
# 例如：
cfg = {
    "SHAREPOINT": {
        "CLIENT_ID": "YOUR_ACTUAL_CLIENT_ID",
        "CLIENT_SECRET": "YOUR_ACTUAL_CLIENT_SECRET",
        "BASE_URL": "https://yourcompany.sharepoint.com/sites/yoursite"
    }
}

# 1. 定义认证参数
client_id = cfg["SHAREPOINT"]["CLIENT_ID"]
client_secret = cfg["SHAREPOINT"]["CLIENT_SECRET"]
base_url = cfg["SHAREPOINT"]["BASE_URL"]

# 2. 创建SharePoint客户端上下文
try:
    ctx = get_client_context(client_id=client_id, client_secret=client_secret, base_url=base_url)
    ctx.load(ctx.web).execute_query() # 验证连接是否成功
    print(f"成功连接到SharePoint站点: {ctx.web.url}")
except Exception as e:
    print(f"连接SharePoint失败: {e}")
    exit()

# 3. 定义要更新的文件路径和属性
# 注意：filepath是文件的服务器相对路径
# 例如：如果您的站点是 https://yourcompany.sharepoint.com/sites/mysite
# 并且文件在 '共享文档/General' 文件夹下，文件名为 'MyDocument.docx'
# 那么相对路径就是 '/sites/mysite/Shared Documents/General/MyDocument.docx'
filepath_to_update = "/sites/yoursite/Shared Documents/General/MyDocument.docx" 

# 定义要更新的属性字典
# 键是SharePoint列的内部名称，值是要设置的新值
properties_to_update = {
    "ProjectStatus": "已完成",  # 假设有一个名为 'ProjectStatus' 的自定义列
    "ReviewDate": "2023-10-26", # 假设有一个名为 'ReviewDate' 的自定义列
    "DocumentOwner": "张三",     # 假设有一个名为 'DocumentOwner' 的自定义列
}

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