如何使用 Sphinx 标记引用记录的 Python 函数参数?

2024-02-05

我想在 Python 文档字符串中的其他位置引用先前记录的函数参数。考虑以下(诚然完全是人为的)示例:

def foo(bar):
    """Perform foo action
    :param bar: The bar parameter
    """

    def nested():
        """Some nested function that depends on enclosing scope's bar parameter.
        I'd like to reference function foo's bar parameter here
        with a link, is that possible?"""
        return bar * bar

    # ...
    return nested()

是否有一种简单的方法可以使用 Sphinx 标记嵌入参数引用,或者这种情况会自动发生吗?

(我是一个完整的 Sphinx 新手。我一直在扫描 Sphinx 文档,但没有找到这个问题的答案,也没有找到演示正确标记的示例。)


没有简单的方法可以直接引用函数的参数sphinx我不知道这个问题的扩展。

The python 域的文档 https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-python-objects解释哪些对象可以交叉引用。

为用户提供参数参考的可能方法bar功能的foo将会

See parameter ``bar`` in :func:`foo`.

也许可以通过编写扩展来直接引用。

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

如何使用 Sphinx 标记引用记录的 Python 函数参数? 的相关文章

  • 如何编写嵌套的 __init__.py 文件

    我正在努力解决嵌套问题 init py在我正在编写的Python包中 该包具有以下架构 module init py submodule1 init py source py submodule2 init py source py sub
  • 如何避免使用 python 处理空的标准输入?

    The sys stdin readline 返回之前等待 EOF 或新行 所以如果我有控制台输入 readline 等待用户输入 相反 我想打印帮助并在没有需要处理的情况下退出并显示错误 而不是等待用户输入 原因 我正在寻找一个Pytho
  • Python 切片对象和 __getitem__

    python 中是否有内部的东西来处理传递给的参数 getitem 不同 并自动转换start stop step构造成切片 这是我的意思的演示 class ExampleClass object def getitem self args
  • 将非常大的Python列表输出保存到mysql表中

    我想将 python 生成的列表的输出保存在 mysql 数据库的表中 该表如下所示 mysql 中的 myapc8 表 https i stack imgur com 4B4Hz png这是Python代码 在此输入图像描述 https
  • 按边距(“全部”)值列对 Pandas 数据透视表进行排序

    我试图根据 pandas 数据透视表中的行总和对最后一列 边距 aggrfunc 进行降序排序 我知道我在这里错过了一些简单的东西 但我无法弄清楚 数据框 数据透视表 WIDGETS DATE 2 1 16 2 2 16 2 3 16 Al
  • 如何通过 python 多处理利用所有核心

    我一直在摆弄Python的multiprocessing现在已经使用了一个多小时的功能 尝试使用并行化相当复杂的图形遍历函数multiprocessing Process and multiprocessing Manager import
  • 创建上下文后将 jar 文件添加到 pyspark

    我正在笔记本上使用 pyspark 并且不处理 SparkSession 的创建 我需要加载一个包含一些我想在处理 rdd 时使用的函数的 jar 您可以使用 jars 轻松完成此操作 但在我的特定情况下我无法做到这一点 有没有办法访问sp
  • Arcpy 模数在 Pycharm 中不显示

    如何将 Arcpy 集成到 Pycharm 中 我尝试通过导入模块但它没有显示 我确实知道该模块仅适用于 2 x python arcpy 在 PyPi Python 包索引 上不可用 因此无法通过 pip 安装 要使用 arcpy 您需要
  • AttributeError:“模块”对象没有属性[重复]

    这个问题在这里已经有答案了 我有两个 python 模块 a py import b def hello print hello print a py print hello print b hi b py import a def hi
  • python 中的 <> 运算符有什么作用?

    我刚刚遇到这个here http www feedparser org feedparser py 总是这样使用 if string1 find string2 lt gt 1 pass 什么是 lt gt 运算符这样做 为什么不使用通常的
  • Sphinx内联代码高亮

    我使用 Sphinx 制作一个包含代码示例的网站 我成功地使用了 code block获取语 法高亮的指令 但我无法使用此代码获得内联语法突出显示 role bash code language bash Test inline bash
  • Ubuntu systemd 自定义服务因 python 脚本而失败

    希望获得有关 Ubuntu 中的 systemd 守护进程服务的一些帮助 我写了一个 python 脚本来禁用 Dell XPS 上的触摸屏 这更像是一个问题 而不是一个有用的功能 该脚本可以工作 但我不想一直启动它 这就是为什么我想到编写
  • Python 中维基百科 API 中的 DisambiguationError 和 GuessedAtParserWarning

    我想获得维基百科与搜索词相关的可能且可接受的名称列表 在这种情况下是 电晕 当输入以下内容时 print wikipedia summary Corona 这给出了以下输出 home virej local lib python3 8 si
  • XPath:通过当前节点属性选择当前和下一个节点的文本

    首先 这是从我之前的问题 https stackoverflow com questions 5202187 xpath select current and next nodes text by current node attribut
  • Django 管理器链接

    我想知道是否有可能 如果可以的话 如何 将多个管理器链接在一起以生成受两个单独管理器影响的查询集 我将解释我正在研究的具体示例 我有多个抽象模型类 用于为其他模型提供小型的特定功能 其中两个模型是DeleteMixin 和GlobalMix
  • 如何编写一个接受 int 或 float 的 C 函数?

    我想用 C 语言创建一个扩展 Python 的函数 该函数可以接受 float 或 int 类型的输入 所以基本上 我想要f 5 and f 5 5 成为可接受的输入 我认为我不能使用if PyArg ParseTuple args i v
  • rpy2 无法加载外部库

    希望有人能帮忙解决这个问题 R版本 2 14 1rpy2版本 2 2 5蟒蛇版本 2 7 3 一直在尝试在 python 脚本中使用 rpy2 加载 R venneuler 包 该包以 rJava 作为依赖项 venneuler 和 rJa
  • 如何从namedtuple实例列表创建pandas DataFrame(带有索引或多索引)?

    简单的例子 from collections import namedtuple import pandas Price namedtuple Price ticker date price a Price GE 2010 01 01 30
  • pandas 中数据帧中的随机/洗牌行

    我目前正在尝试找到一种方法来按行随机化数据框中的项目 我在 pandas 中按列洗牌 排列找到了这个线程 在 pandas 中对 DataFrame 进行改组 排列 https stackoverflow com questions 157
  • 定义在文本小部件中双击时选择哪些字符

    在 Windows 上 双击文本小部件中的单词也将选择连接的标点符号 有什么方法可以定义您想要选择的角色吗 tcl wordchars该变量的值是一个正则表达式 可以设置它来控制什么被视为 单词 字符 例如 通过双击 Tk 中的文本来选择单

随机推荐

  • 如何在实际的 Apple Watch(而不是模拟器中)上强制退出单个应用程序?

    开发应用程序时 有时强制退出应用程序很有用 而无需重新启动整个设备 在我的 iPhone 上 我可以通过双击主页按钮并将应用程序滑动到顶部来强制退出活动应用程序 对于实际的 Apple Watch 不是模拟器 强制退出应用程序特别有用 因为
  • Android - 位图缓存占用大量内存

    我对所有内存管理主题都是新手 所以有很多东西我不明白 我正在尝试在我的应用程序中缓存图像 但我遇到了内存消耗问题 所有位图 Chaching 代码几乎都是从这里复制粘贴的 http developer android com trainin
  • 通过管道id杀死linux进程

    我想杀死一个进程并通过以下方式获取它的 id pgrep f python myscript py 我想打电话 kill s SIGINT 对此 但我找不到任何方法来做到这一点 该命令需要在一行中 尝试使用反引号运算符来评估子命令 kill
  • BizTalk Server 有哪些可行的替代方案? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 在评估不同的系统集成策略时 我听到了一些关于 BizTalk Server 的鼓励的话 但也听到了一些
  • 如何在不停止站点的情况下更新 ASP.Net 站点 dll

    是否可以在不停止 IIS 的情况下更新预编译站点的站点 dll 目前 如果我尝试复制新文件来覆盖当前文件 则所有用户在复制文件时都会收到运行时错误 有办法避免这种情况吗 即使您不停止 对 web config 文件 BIN 文件夹 App
  • 如何使用选择文件浏览器的意图来选择文件

    如何使用意图提示用户选择 完成操作 来选择应用程序来选择文件 假设设备中有几个应用程序来浏览文件 我想使用扩展名过滤文件 例如 sav props 先感谢您 你可以使用这样的东西 Intent intent new Intent Inten
  • Mongoid 查找器不工作?

    我已经设置了一个 Rails3 mongoid 应用程序 当我打开 Rails 控制台时 所有查找器似乎都不起作用 http d pr FNzC http d pr FNzC User all User find all condition
  • Channel ManagedChannelImpl 未正确关闭

    如果我运行这两个测试 我会收到错误 1st test Rule public GrpcCleanupRule grpcCleanup new GrpcCleanupRule Test public void findAll throws E
  • 没有名为“ASP.NET 4.6.81.0”的事件日志源。该模块需要.NET Framework 2.0

    我刚刚安装了 VS 2015 Community 并在尝试访问 IIS 中托管的 ASP NET 应用程序 使用 ASP NET v4 0 应用程序池 时 收到了该错误消息 我刚刚下载了 NET Framework 4 6 离线安装程序 它
  • 查找谁在调用该方法

    我想以某种方式找出哪个 CFC 正在调用我的方法 我有一个记录 CFC 它被许多不同的 CFC 调用 在此日志记录 CFC 上 需要存储哪个 CFC 调用日志 虽然我可以简单地将 CFC 名称作为参数传递给 log cfc 但我发现这是一项
  • 从 DataReader 访问 DateTime 字段时出现 MySqlConversionException

    我有一个基于 MySql 的 C 应用程序 使用MySQL 连接器 http www mysql com 我正在尝试做一个 DataReader 请求 查询执行正常 但是 当尝试访问 DateTime 字段时 我收到 MySqlConver
  • PHP Mail() 中的 Base 64 附件不起作用

    我有一个脚本 当函数运行时 它会发送一封自动电子邮件 我希望能够发送 HTML 电子邮件以及 PDF 附件 我知道我需要将文件编码为 Base64 但是我只是将 Base64 代码附加到我的电子邮件底部 我认为这与哑剧有关 有人看到这个问题
  • 如何在加载到数据表时取消合并并填充 Excel 文件中的单元格

    I have an excel file as show below 我使用以下代码将文件加载到数据表中 string sSheetName GetSheetName Get data sheet name string connStrin
  • TextInputLayout 提示颜色

    我正在使用新的 Google 设计库 com android support design 22 2 0 但遇到问题android support design widget TextInputLayout 如果我以编程方式设置其 Edit
  • 如何使用 JAXB 删除 XML 中的标签

    我正在使用 JAXB 将 java 对象转换为 xml 文件 在我的 XML 文件中 我需要删除标签不使用 XSLT 例如 删除标签订单
  • 如何在 Spring 中注入具有受保护方法的 JDK 代理类?

    我的情况相当奇怪 我使用 Spring 3 0 6 和一个实现和接口的 bean 到目前为止 都是很正常的事情 我的 bean 也有一些受保护的方法 我正在使用一些 AOP JDK 代理 一切正常 当我想将此 bean 注入另一个包类时 我
  • Angular 测试获取实际的 HTTP 响应

    我是角度单元测试的新手 我想要做的是从我的 API 获取实际结果 我检查了this https angular io guide http testing http requests文档 但据我了解 我应该创建模拟响应 这是我的代码 myS
  • Visual Studio Code 有“后退”按钮吗?

    When I Cmd click在函数的执行行 f 它带我到定义函数的地方 f 既然我已经看完了这个功能 如果有一个 后退 按钮可以回到之前的位置就太好了 有谁知道这样的功能或有帮助的功能 附 我在 Mac 上 在 Windows VS C
  • Java ME 日历不显示

    我一直在这里关注本教程 教程链接 http www developer nokia com Community Wiki Building a Java ME Canvas based calendar date picker 但我似乎无法
  • 如何使用 Sphinx 标记引用记录的 Python 函数参数?

    我想在 Python 文档字符串中的其他位置引用先前记录的函数参数 考虑以下 诚然完全是人为的 示例 def foo bar Perform foo action param bar The bar parameter def nested