¥
立即购买

Python函数文档字符串生成器

0 浏览
0 试用
0 购买
Dec 10, 2025更新

本提示词专为Python开发者设计,能够根据输入的Python函数代码自动生成符合PEP 257标准的专业文档字符串。通过分析函数结构、参数类型和返回值,生成包含功能描述、参数说明、返回值和示例用法的完整文档。支持生成适用于不同场景的文档风格,包括标准格式、NumPy风格和Google风格,帮助开发者提升代码可读性和维护性,适用于函数开发、代码重构和项目文档编写等多种开发场景。

函数功能概述

  • 计算数值序列的基础统计量,包括计数、均值、中位数与标准差。
  • 输入序列中不可转换为浮点数的元素会被忽略;NaN 会被统计计数但不参与计算(可选择是否在结果中保留 NaN 计数)。
  • 标准差支持两种方法:
    • population:总体标准差(除以 n)
    • sample:样本标准差(除以 n-1)

参数详细说明

  • data: Sequence[float] | Iterable
    • 可迭代的数值集合。序列中的元素需可被 float(x) 成功转换;不可转换的元素会被忽略。字符串或字节串本身不被接受。
  • method: str
    • 标准差计算方法,可选值:
      • "population":总体标准差(默认)
      • "sample":样本标准差
  • keep_nan: bool
    • 是否在返回结果中保留遇到的 NaN 个数:
      • True:返回实际 NaN 个数
      • False:返回 0.0(默认)

返回值说明

  • 返回类型:Dict[str, float]
  • 字段说明:
    • count:有效数值的个数(浮点数表示,不包含 NaN 和不可转换元素)
    • nan_count:NaN 的个数(当 keep_nan=True 时为实际计数,否则为 0.0)
    • mean:均值(基于有效数值)
    • median:中位数(基于有效数值)
    • std:标准差(依据 method,population 为总体标准差,sample 为样本标准差)

使用示例

  • 基本用法(默认总体标准差,省略 NaN 计数)
    • 输入:
      • data = [1, 2, 3, float('nan'), '4', None, 'a']
      • 调用:compute_statistics(data)
    • 输出:
      • { "count": 4.0, "nan_count": 0.0, "mean": 2.5, "median": 2.5, "std": 1.118033988749895 }
  • 样本标准差并保留 NaN 计数
    • 调用:compute_statistics([1, 2, 3, float('nan'), '4', None, 'a'], method="sample", keep_nan=True)
    • 输出:
      • { "count": 4.0, "nan_count": 1.0, "mean": 2.5, "median": 2.5, "std": 1.2909944487358056 }

注意事项

  • data 为字符串或字节串将被视为无效输入并抛出异常,即使其可迭代。
  • 输入序列中不可转换为浮点数的元素(如 'a'、None)会被忽略,不会导致错误。
  • NaN 不参与统计计算;仅在 keep_nan=True 时,其出现次数会体现在结果中。
  • 选择 method="sample" 时,至少需要 2 个有效数值;否则标准差计算会报错。
  • 当所有元素均不可用(全为 NaN 或不可转换),将无法计算统计量并抛出异常。

相关异常说明

  • TypeError
    • 当 data 是字符串/字节串,或 data 不是可迭代对象时。
  • ValueError
    • 当 method 不是 "population" 或 "sample"。
    • 当过滤无效元素后没有任何可用数值(no valid numeric values to compute statistics)。
  • statistics.StatisticsError
    • 当 method="sample" 且有效数值少于 2 个时,由 statistics.stdev 抛出(例如 “variance requires at least two data points”)。

函数功能概述

  • 将嵌套的映射(Mapping,如 dict)和列表按路径“扁平化”为单层字典。
  • 路径通过分隔符拼接各级键/索引(默认“.”),可选起始前缀 parent_key。
  • 支持按键排序以获得稳定输出次序。
  • 可通过 max_depth 限制展开深度;超过深度的子对象将作为整体保留为值。

参数详细说明(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)

    {'a.b': 1, 'a.c.0': 10, 'a.c.1': 20, 'd': 2}

  • 限制展开深度(max_depth=1,仅展开一层路径, deeper 保留为整体): result = flatten_dict({"a": {"b": 1, "c": [10, 20]}, "d": 2}, max_depth=1) pprint(result)

    {'a.b': 1, 'a.c': [10, 20], 'd': 2}

  • 使用起始前缀与自定义分隔符: result = flatten_dict({"a": {"b": 1}, "d": 2}, parent_key="root", sep="/") pprint(result)

    {'root/a/b': 1, 'root/d': 2}

注意事项

  • 列表会被展开为以下标命名的路径段(如 "items.0", "items.1")。
  • 分隔符 sep 不会对原键名进行转义;若原始键中包含分隔符,可能导致路径歧义与键碰撞。
  • 键碰撞时,后遍历到的条目会覆盖先前的值;开启 sort_keys=True 可使覆盖顺序稳定但不能避免碰撞。
  • max_depth 的判断基于 “当前递归深度 depth > max_depth 即停止”;例如 max_depth=1 时,"a.b" 会被展开为键,但 "a.c" 下的列表将整体保留为值。
  • 该函数使用递归实现;在极深的嵌套结构上可能触发 RecursionError。
  • 当 sort_keys=True 且映射的键类型不可比较(如混合不同类型的键)时,排序可能失败。

相关异常说明 Raises: TypeError: 当 data 不是 Mapping 时抛出;或在 sort_keys=True 时,若键不可比较导致排序失败时由底层 sorted 抛出。 ValueError: 当 sep 为空字符串时抛出。

示例详情

解决的问题

用最少的时间,为任意一段Python函数代码,一键生成可直接粘贴的高质量文档字符串;支持标准、Google、NumPy三种风格与中/英文输出,自动覆盖功能概述、参数/返回值说明、示例与注意事项;确保描述与代码逻辑精准一致,帮助个人与团队统一文档风格、缩短评审周期、快速补齐遗留项目文档,在重构、对外发布与开源贡献中提升专业度并促成高质量交付。

适用用户

后端Python开发工程师

在迭代中为新函数快速产出规范文档,并为复杂逻辑标注参数、返回值与异常,减少回归缺陷与代码返工。

项目技术负责人/架构师

统一团队文档风格与质量门槛,在代码评审前补齐说明,确保一致性与合规,缩短评审周期。

开源项目维护者

为社区提交的代码自动生成多语言文档字符串与示例,降低参与门槛,提升PR可读性与合并效率。

特征总结

依据函数代码自动生成规范文档字符串,几秒补齐说明,显著提升可读性与交接效率。
一键切换标准、NumPy、Google等文档风格,项目内统一格式,团队协作更顺畅。
自动梳理参数名称、类型与默认值,配合清晰用途描述,避免遗漏与误解。
明确返回值含义与可能抛出的异常,让调用方少试错,减少沟通与返工。
自动生成可复制的使用示例,贴近实际调用场景,帮助新人快速上手。
支持按需选择输出语言,方便对内对外文档共享与开源发布。
贯穿新函数开发、存量代码重构与代码评审场景,持续提升文档覆盖率。
基于函数逻辑优化表述,杜绝模糊与猜测,降低后期维护与培训成本。
与提交合并流程配合,快速补齐缺失注释,提高代码审查与合并效率。

如何使用购买的提示词模板

1. 直接在外部 Chat 应用中使用

将模板生成的提示词复制粘贴到您常用的 Chat 应用(如 ChatGPT、Claude 等),即可直接对话使用,无需额外开发。适合个人快速体验和轻量使用场景。

2. 发布为 API 接口调用

把提示词模板转化为 API,您的程序可任意修改模板参数,通过接口直接调用,轻松实现自动化与批量处理。适合开发者集成与业务系统嵌入。

3. 在 MCP Client 中配置使用

在 MCP client 中配置对应的 server 地址,让您的 AI 应用自动调用提示词模板。适合高级用户和团队协作,让提示词在不同 AI 工具间无缝衔接。

AI 提示词价格
¥20.00元
先用后买,用好了再付款,超安全!

您购买后可以获得什么

获得完整提示词模板
- 共 548 tokens
- 3 个可调节参数
{ Python函数代码 } { 文档风格 } { 输出语言 }
获得社区贡献内容的使用权
- 精选社区优质案例,助您快速上手提示词
使用提示词兑换券,低至 ¥ 9.9
了解兑换券 →
限时半价

不要错过!

半价获取高级提示词-优惠即将到期

17
:
23
小时
:
59
分钟
:
59