热门角色不仅是灵感来源,更是你的效率助手。通过精挑细选的角色提示词,你可以快速生成高质量内容、提升创作灵感,并找到最契合你需求的解决方案。让创作更轻松,让价值更直接!
我们根据不同用户需求,持续更新角色库,让你总能找到合适的灵感入口。
本提示词专为Python开发者设计,能够根据输入的Python函数代码自动生成符合PEP 257标准的专业文档字符串。通过分析函数结构、参数类型和返回值,生成包含功能描述、参数说明、返回值和示例用法的完整文档。支持生成适用于不同场景的文档风格,包括标准格式、NumPy风格和Google风格,帮助开发者提升代码可读性和维护性,适用于函数开发、代码重构和项目文档编写等多种开发场景。
函数功能概述
参数详细说明
返回值说明
使用示例
注意事项
相关异常说明
函数功能概述
参数详细说明(Google 风格) Args: data (Mapping[str, Any]): 待扁平化的数据。顶层必须是映射类型(如 dict)。嵌套处可包含映射或列表,其他类型被视为叶子值。 parent_key (str, optional): 起始路径前缀,最终键会在其后继续拼接。默认 "" 不添加前缀。 sep (str, optional): 路径分隔符,用于连接各级键/索引。默认 "."。不能为空字符串。 max_depth (Optional[int], optional): 最大展开深度(从 0 起算)。当递归深度 depth > max_depth 时,不再继续下钻,当前对象作为值保留。默认 None 表示无限展开。 sort_keys (bool, optional): 是否对映射的键进行排序后再遍历,保证确定性输出顺序。默认 True。
返回值说明 Returns: dict[str, Any]: 扁平化后的字典。键为用分隔符连接的路径(映射键与列表下标),值为对应的叶子值或在达到深度上限时的未展开子对象。
使用示例
基本用法(嵌套字典与列表): from pprint import pprint
data = {"a": {"b": 1, "c": [10, 20]}, "d": 2} result = flatten_dict(data) pprint(result)
限制展开深度(max_depth=1,仅展开一层路径, deeper 保留为整体): result = flatten_dict({"a": {"b": 1, "c": [10, 20]}, "d": 2}, max_depth=1) pprint(result)
使用起始前缀与自定义分隔符: result = flatten_dict({"a": {"b": 1}, "d": 2}, parent_key="root", sep="/") pprint(result)
注意事项
相关异常说明 Raises: TypeError: 当 data 不是 Mapping 时抛出;或在 sort_keys=True 时,若键不可比较导致排序失败时由底层 sorted 抛出。 ValueError: 当 sep 为空字符串时抛出。
用最少的时间,为任意一段Python函数代码,一键生成可直接粘贴的高质量文档字符串;支持标准、Google、NumPy三种风格与中/英文输出,自动覆盖功能概述、参数/返回值说明、示例与注意事项;确保描述与代码逻辑精准一致,帮助个人与团队统一文档风格、缩短评审周期、快速补齐遗留项目文档,在重构、对外发布与开源贡献中提升专业度并促成高质量交付。
在迭代中为新函数快速产出规范文档,并为复杂逻辑标注参数、返回值与异常,减少回归缺陷与代码返工。
统一团队文档风格与质量门槛,在代码评审前补齐说明,确保一致性与合规,缩短评审周期。
为社区提交的代码自动生成多语言文档字符串与示例,降低参与门槛,提升PR可读性与合并效率。
将模板生成的提示词复制粘贴到您常用的 Chat 应用(如 ChatGPT、Claude 等),即可直接对话使用,无需额外开发。适合个人快速体验和轻量使用场景。
把提示词模板转化为 API,您的程序可任意修改模板参数,通过接口直接调用,轻松实现自动化与批量处理。适合开发者集成与业务系统嵌入。
在 MCP client 中配置对应的 server 地址,让您的 AI 应用自动调用提示词模板。适合高级用户和团队协作,让提示词在不同 AI 工具间无缝衔接。
半价获取高级提示词-优惠即将到期