使用Python API更新SharePoint文件自定义属性和列

import os
from office365.sharepoint.client_context import ClientContext
# 假设您有一个辅助函数来获取ClientContext，例如：
# from your_module import get_client_context

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

    Args:
        ctx: SharePoint客户端上下文对象。
        filepath: 文件的服务器相对路径，例如 '/sites/<site_name>/Shared Documents/General/path_to_file'。
        properties: 包含要更新的属性名（作为键）和新值（作为值）的字典。
                    属性名应与SharePoint中自定义列的内部名称（Internal Name）一致。
    Returns:
        None
    """

    print(f"尝试更新文件: {os.path.basename(filepath)}")
    # 获取文件对应的列表项，以便访问其属性
    file_item = ctx.web.get_file_by_server_relative_path(filepath).listItemAllFields

    # 为每个属性构建更新查询
    for k, v in properties.items():
        # 设置属性值，persist_changes=True 确保更改被保存
        file_item.set_property(name=k, value=v, persist_changes=True)
        print(f'已将属性 "{k}" 设置为 "{v}"')

    # 发送批量更新查询
    file_item.update().execute_query()
    print(f'文件 {os.path.basename(filepath)} 的所有指定属性已成功更新。')

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

# 假设您有一个配置文件 (e.g., config.ini, config.json) 存储敏感信息
# 这里我们直接定义，实际应用中建议从配置文件或环境变量读取
class Config:
    SHAREPOINT = {
        "CLIENT_ID": "YOUR_CLIENT_ID", # 替换为您的SharePoint应用注册的客户端ID
        "CLIENT_SECRET": "YOUR_CLIENT_SECRET", # 替换为您的SharePoint应用注册的客户端密钥
        "BASE_URL": "https://yourdomain.sharepoint.com/sites/YourSiteName" # 替换为您的SharePoint站点URL
    }

cfg = Config() # 实例化配置类

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 = cfg.SHAREPOINT["CLIENT_ID"]
client_secret = cfg.SHAREPOINT["CLIENT_SECRET"]
base_url = cfg.SHAREPOINT["BASE_URL"]

# 创建SharePoint上下文进行认证
try:
    ctx = get_client_context(
        client_id=client_id, client_secret=client_secret, base_url=base_url
    )
    # 尝试执行一个简单的查询来验证连接
    ctx.web.get().execute_query()
    print("成功连接到SharePoint！")
except Exception as e:
    print(f"连接SharePoint失败: {e}")
    exit()

# 替换为您要更新的文件的服务器相对路径
# 例如："/sites/MySite/Shared Documents/General/MyDocument.docx"
filepath = "/sites/YourSiteName/Shared Documents/General/path_to_your_file.pdf"

# 定义要更新的属性字典
# 键是SharePoint列的内部名称，值是您要设置的新值
properties_to_update = {
    "Property1InternalName": "Value For Property 1",
    "Property2InternalName": "Value For Property 2",
    "CustomColumnDate": "2023-10-26T10:00:00Z" # 日期时间格式示例
}

# 运行更新函数
try:
    update_sp_file_property(ctx=ctx, filepath=filepath, properties=properties_to_update)
    print("文件属性更新操作完成。")
except Exception as e:
    print(f"更新文件属性时发生错误: {e}")