文档字符串中的重复内容

2023-12-20

处理文档字符串中重复内容的好方法是什么?我有许多采用“标准”参数的函数,这些参数必须在文档字符串中进行解释,但是最好只编写文档字符串的相关部分一次,因为这会更容易维护和更新。我天真地尝试了以下方法:

arg_a = "a: a very common argument"

def test(a):
    '''
    Arguments:
    %s
    ''' % arg_a
    pass

但这不起作用,因为当我这样做时help(test)我没有看到文档字符串。有没有好的方法可以做到这一点?


正如其他答案所说,您需要更改__doc__函数对象的成员。一个好方法是使用一个装饰器来对文档字符串执行格式化:

def fixdocstring(func):
    func.__doc__ = func.__doc__.replace('<arg_a>', 'a: a very common argument')
    #(This is just an example, other string formatting methods can be used as well.)
    return func

@fixdocstring
def test(a):
    '''
    Arguments:
    <arg_a>
    ''''
    pass
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

文档字符串中的重复内容 的相关文章

  • 与 iexact 一起使用时,Django get_or_create 无法设置字段

    我想用name iexact with get or create尽可能避免用户输入字段的重复 我的提供者模型有一个名称字段 我在其中使用get or create 查找工作正常 但在第一次创建实例时 如下面的 p1 Timber 示例 名
  • python导入模块时如何避免一直写模块名?

    我用math最近模块很多 我不想写math sqrt x and math sin x 每时每刻 我想缩短它并写sqrt x and sin x How 对于较长的模块名称 通常会缩短它们 例如 import numpy as np 然后您
  • DataFrame 在函数内部修改

    我面临一个我以前从未观察到的函数内数据帧修改的问题 有没有一种方法可以处理这个问题 以便初始数据帧不被修改 def test df df tt np nan return df dff pd DataFrame data 现在 当我打印时d
  • Python:记录垃圾收集器

    我有一个 python 应用程序 有一些性能问题 我想将垃圾收集器的事件 特别是何时调用 添加到我的日志中 是否可以 thanks http docs python org library gc html gc set debug http
  • Python 中的安全解除引用

    Groovy 有一个很好的安全取消引用运算符 这有助于避免 NullPointerExceptions variable method The method仅当以下情况时才会被调用variable is not null 有没有办法在 Py
  • Python,将迭代函数变成递归函数

    我创建了一个输出 4 3 2 1 0 1 2 3 4 的迭代函数 def bounce2 n s n for i in range n print n n n 1 if n lt 0 for i in range s 1 print n n
  • 在Python中创建一个新表

    我正在尝试从数控机床中提取数据 事件每毫秒发生一次 我需要过滤掉一些用管道 分隔的变量分隔符 PuTTy exe 程序生成的日志文件 我尝试阅读熊猫 但列不在同一位置 df pd read table data log sep 日志文件的一
  • 为 Networkx 图添加标题?

    我希望我的代码创建一个带有标题的图 使用下面的代码 可以创建绘图 但没有标题 有人可以告诉我我做错了什么吗 import pandas as pd import networkx as nx from networkx algorithms
  • 用Python中的嵌套for循环替换重复的if语句?

    在我编写的下面的代码中 n 4 所以有五个 if 语句 所以如果我想将 n 增加到 比如说 10 那么就会有很多 if 语句 因此我的问题是 如何用更优雅的东西替换所有 if 语句 n p 4 5 number of trials prob
  • 网页抓取 - 前往第 2 页

    如何访问数据集的第二页 无论我做什么 它都只返回第 1 页 import bs4 from urllib request import urlopen as uReq from bs4 import BeautifulSoup as sou
  • Django - 电子邮件发送两次

    每当我使用如下所示的电子邮件设置从views py调用下面的方法时 电子邮件的两份副本都会发送给收件人 并且我收到如下所示的错误 def sendEmailBasic request msg EmailMessage Request Cal
  • 在Python中删除带有重音符号的字符串中的所有非字母字符

    我正在尝试使用 Python 3 7 从包含重音符号的字符串中删除所有非字母字符 空格除外 我尝试了以下方法 import re text 29 1981 4 2008 clean text re sub W d text print cl
  • RuntimeError: 预期所有张量都在同一设备上,但发​​现至少有两个设备,cpu 和 cuda:0!使用我的模型进行预测时

    我使用变压器训练了一个序列分类模型 BertForSequenceClassification 我收到错误 预计所有张量都在同一设备上 但发 现至少有两个设备 cpu 和 cuda 0 在方法wrapper index select中检查参
  • Python正则表达式从字符串中获取浮点数

    我正在使用正则表达式来解析字符串中的浮点数 re findall a zA Z d d t 是我使用的代码 这段代码有问题 如果数字和任何字符之间没有空格 则不会解析该数字 例如 0 1 2 3 4 5 6 7 8 9 的预期输出为 0 1
  • 如何检查列表是否为空?

    这个问题的答案是社区努力 help privileges edit community wiki 编辑现有答案以改进这篇文章 目前不接受新的答案或互动 例如 如果通过以下内容 a 我如何检查是否a是空的 if not a print Lis
  • 为什么“return self”返回 None ? [复制]

    这个问题在这里已经有答案了 我正在尝试获取链的顶部节点getTopParent 当我打印出来时self name 它确实打印出了父实例的名称 然而 当我回来时self 它返回 None 为什么是这样 class A def init sel
  • Django 接受 AM/PM 作为表单输入

    我试图弄清楚如何使用 DateTime 字段在 Django 中接受 am pm 作为时间格式 但我遇到了一些麻烦 我尝试在 forms py 文件中这样设置 pickup date time from DateTimeField inpu
  • 如何向 SCons 构建添加预处理和后处理操作?

    我正在尝试在使用 SCons 构建项目时添加预处理和后处理操作 SConstruct 和 SConscript 文件位于项目的顶部 预处理动作 生成代码 通过调用不同的工具 gt 不知道在此预处理之后将生成的确切文件 可以创建用于决定生成哪
  • 为什么 bot.get_channel() 会产生 NoneType?

    我正在制作一个 Discord 机器人来处理公告命令 当使用该命令时 我希望机器人在特定通道中发送一条消息 并向用户发送一条消息以表明该命令已发送 但是 我无法将消息发送到频道 我尝试了这段代码 import discord import
  • Python 枚举子集迭代

    我想迭代以下枚举的子集 class Items enum Enum item1 0 item2 1 item3 2 item4 3 item5 4 item6 5 item7 6 item8 7 说我想 for item in Items

随机推荐

  • 使用 Java 将 Paypal 集成到 Web 应用程序中

    我想将 paypal 集成到我的网络应用程序中 我正在使用 RESTEasy API 来处理宁静的请求 我想知道如何将 paypal 集成到我的应用程序中 我已经从他们的网站下载了 paypal java sdk 但现在我没有好的应用程序可
  • Powershell:导入模块

    我一直在尝试在 win2008 标准服务器上使用应用程序结构缓存 当我执行以下命令时 我得到 导入模块分布式缓存管理 Import Module 未加载指定的模块 DistributedCacheAdministration 因为在任何模块
  • 加载位图时出现内存不足错误

    我有一个带有 3 个活动的 Android 应用程序 A1 starts gt A2 starts gt A3 当完成他的过程时 开始 gt A1 所以我不会 finish 应用程序 我在用户交互后始终用 startActivity 开始下
  • Seaborn ValueError:零大小数组到没有身份的缩减操作最小值

    我从他们自己的例子中运行了这个散点图seaborn示例website https seaborn pydata org generated seaborn scatterplot html import seaborn as sns sns
  • System.Drawing.Image.FromStream() 方法中的“参数无效”异常

    我在网站中使用 Image FromStream 方法时遇到了困难 下面的代码在我的电脑上完美运行 但是当我将其上传到测试服务器时 它总是给出 参数无效 异常 if afuImageFile IsUploading afuImageFile
  • 如何设置散景中选定/未选定字形的属性

    我有一个由一些可观测值的时间序列组成的数据集 我想使用散景来查看时间序列中不同点的相图 我想知道的是如何更改选定或未选定字形的属性 在这种情况下 我想减少未选定点的 alpha 或更改选定点的颜色 下面的代码创建了我想要在 ipython
  • 验证器和 ClientIDMode 问题 (ASP.NET)

    ASP NET 4 0 引入了 ClientIDMode 属性 它允许指定如何在输出 html 中呈现 html 元素的 id 我的项目当前设置为 静态 最短 不包含层次结构 ID 当使用任何验证器时 RequiredFieldValida
  • Angular 2 - 在会话中存储的便捷方式

    有没有一种方便的方法可以保存在 sessionStorage 中 而不需要手动监视属性更改和更新 例如 我有一个带有属性 query 的 SearchComponent export class SearchComponent privat
  • 如何在 UISplitViewController 中命名后退按钮

    I have UITableViewController 其名称为新闻 和UIViewController 其名称为 DetailViewController 和UISplitViewController 我希望它在纵向使用 iPad 时显
  • 使用 File.Copy 移动文件或将流写入该位置有什么区别吗?

    我正在重构一些代码 并且有一个问题 我可以对其进行一些评论 原始代码将文件下载到流中 然后 它将流写入临时目录中的文件 然后使用 File Copy 覆盖生产目录中的现有文件 首先将其写入临时目录并使用 File Copy 与立即将流写入生
  • 如何更改 屏幕以使用

    我有这个代码 目前是 和 的组合 我想转向相对布局 但还没有看到这么多这样的例子 对于如何实现这一点的任何建议 我们将不胜感激 关于 XAML 的一些要点 屏幕上出现emptyGrid或phraseGrid 屏幕上出现buttonGrid或
  • Symfony 2.3 - 自定义致命错误

    我在 Symfony 2 3 上遇到了问题 我无法让它工作来获取处理致命错误的自定义函数 Symfony 异常工作正常 如 404 等 但致命错误则不然 这是我在互联网上搜索后得到的 我在 TestBundle 中创建了一个父控制器 另一个
  • 如何在Turbo c++ 4.0中读取文件中的数据?

    我是编程初学者 我正在尝试编写一个从文件中读取 2 个数字的代码 然后 将其显示在 Turbo C 的输出窗口中 我的代码仅读取第一个数字并产生错误的输出 对于第二个数字 include
  • 如何用纯 SQL 编写 LINQ 的 .Skip(1000).Take(100) ?

    SQL 的等价物是什么 Skip LINQ 中的方法 例如 我想从特定数据库表中选择第 1000 1100 行 只用 SQL 就可以做到这一点吗 或者我是否需要选择整个表 然后在内存中查找行 如果可能的话 我希望避免这种情况 因为桌子可能很
  • iPad 分屏视图更改主导航栏颜色

    奇怪的问题 将我的应用程序旋转到纵向 选择工具栏项目并公开 uipopovercontroller 后 如果我旋转回横向 右侧的 UINavigationController SplitView 的 objectAtIndex 0 会更改导
  • “简单表单”的 asp.net mvc 模型继承

    你将如何实施这个 我有以下模型 class Something public string Label get set public DateTime Date1 get set class SomethingStage2 Somethin
  • ASP.NET MVC 跟踪问题

    Question 如何使 ASP NET MVC 跟踪信息与作为 Trace axd 的页内跟踪输出保持一致 我可能遗漏了一些明显的东西 如果你看到它 请指出 传统 ASP NET 的背景信息 因此 回到常规的 ASP NET 时代 您只需
  • cygwin 如何/为何破坏 Windows 权限?

    我们收到 来自现场 即来自安装软件的系统管理员 的投诉 称 cygwin 搞乱 了 NTFS 上的 Windows 权限 Windows 7 10 2008 2012 等 问题用例 一般用例是这样的 系统管理员从 cygwin bash c
  • PyCharm,某些包无法导入Pandas,ImportError:C扩展:StringIO未构建

    我遇到一个非常奇怪的错误并且无法解决它 我有一个具有以下目录结构的项目 ptouch ptouch init py ptouch py io py tests init py tests py 我正在使用 PyCharm 社区版和 Anac
  • 文档字符串中的重复内容

    处理文档字符串中重复内容的好方法是什么 我有许多采用 标准 参数的函数 这些参数必须在文档字符串中进行解释 但是最好只编写文档字符串的相关部分一次 因为这会更容易维护和更新 我天真地尝试了以下方法 arg a a a very common