使用Python API更新SharePoint文件自定义属性（列）教程

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

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

    Args:
        ctx: SharePoint客户端上下文对象。
        filepath: 文件的服务器相对路径（例如 "/sites/mysite/Shared Documents/General/my_file.docx"）。
        properties: 一个字典，键为属性（列）的内部名称，值为要更新的属性值。
    Returns:
        None
    """
    try:
        # 获取文件对应的列表项的所有字段
        # 注意：这里的.listItemAllFields会返回一个ListItem对象，包含文件的所有元数据
        file_item = ctx.web.get_file_by_server_relative_path(filepath).listItemAllFields

        # 遍历所有要更新的属性，并为ListItem对象设置属性
        # persist_changes=True 确保这些更改会被标记并最终提交
        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}"')

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

    except Exception as e:
        print(f"更新文件 '{filepath}' 属性时发生错误: {e}")
        # 在实际应用中，您可能需要更详细的错误处理和日志记录

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

# 假设您的配置信息存储在一个字典或配置文件中
# 这里为了示例方便，直接定义
cfg = {
    "SHAREPOINT": {
        "CLIENT_ID": "YOUR_CLIENT_ID",       # 替换为您的Client ID
        "CLIENT_SECRET": "YOUR_CLIENT_SECRET", # 替换为您的Client Secret
        "BASE_URL": "https://yourcompany.sharepoint.com/sites/yoursite" # 替换为您的SharePoint站点URL
    }
}

# 辅助函数：创建SharePoint客户端上下文
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上下文进行认证
ctx = get_client_context(
    client_id=client_id, client_secret=client_secret, base_url=base_url
)

# 定义要更新的文件路径
# 请替换为您的文件在SharePoint中的服务器相对路径
# 例如："/sites/<sharepoint_site_name>/Shared Documents/General/your_document.pdf"
filepath = "/sites/mysite/Shared Documents/General/MyTestDocument.docx"

# 定义要更新的属性及其新值
# 键是SharePoint列的内部名称，值是您想要设置的新值
properties_to_update = {
    "Property1": "NewValueA",
    "Property2": "NewValueB",
    "CustomColumnName": "Updated Text"
}

# --- 运行函数更新文件属性 ---
print(f"尝试更新文件 '{filepath}' 的属性...")
update_sp_file_property(ctx=ctx, filepath=filepath, properties=properties_to_update)