🚀 AI 一键生成 joinquant 策略代码

在JoinQuant聚宽平台如何快捷查看内建函数参数?

joinquant | 发布时间: 2026/5/27
以下内容由 EasyQuant 生成。

问题描述

聚宽上的内建函数

聚宽上的内建函数要怎么才能跳转到内部去查看内建函数?比如:我不知道传那些参数,我跳转到内建函数内部我就知道需要传那些些参数了。就拿get_dominant_future()获取主力合约而言,我知道你们官方文档api中有介绍的,但我要是能直接跳转到函数内部。我能更快速的知道怎么传参,不需要去官方文档中找。

解决方案

在JoinQuant(聚宽)平台上,由于核心API函数(如 get_dominant_futureget_price 等)通常是在底层封装好的(部分为了安全和性能进行了编译或闭源处理),因此无法像在本地IDE中那样直接通过“Ctrl+左键”跳转到源码内部查看具体的代码实现

但是,如果您只是为了快速查看需要传递哪些参数以及参数的说明,而不想每次都去翻阅官方文档,聚宽的研究环境(基于Jupyter Notebook)为您提供了几种非常高效的快捷查看方法:

方法一:使用 Shift + Tab 快捷键(最推荐)

在聚宽的“投资研究”环境中编写代码时,当您输入函数名并打出左括号 ( 后,将光标停留在括号内,按下键盘上的 Shift + Tab 键。

  • 效果:会弹出一个悬浮窗,直接显示该函数的参数列表(Signature)和简短的文档说明(Docstring)。
  • 进阶:连按两次 Shift + Tab 可以展开更详细的说明窗口。
  • 示例:输入 get_dominant_future( 然后按 Shift + Tab,就能看到它需要 underlying_symboldate 参数。

方法二:使用 ??? 查询

在研究环境中,您可以在函数名后面加上一个问号 ? 然后运行该代码块(Cell)。

  • 代码get_dominant_future?
  • 效果:会在页面下方弹出一个窗口,详细展示该函数的定义(Signature)和官方文档注释(Docstring),里面清楚地写明了参数要求和返回值。
  • :如果使用两个问号 ??,对于部分纯Python编写的开源函数,甚至可以直接打印出它的源代码。

方法三:使用 Python 内置的 help() 函数

无论是在研究环境还是在回测代码中,您都可以使用Python自带的 help() 函数将其打印出来。

  • 代码help(get_dominant_future)
  • 效果:在输出日志中打印出该函数的参数结构和说明文档。

方法四:本地使用 JQDataSDK + 本地 IDE

如果您非常习惯“跳转到定义”这种开发模式,建议您在本地电脑上使用 PyCharm 或 VSCode,并安装聚宽的本地数据包 jqdatasdk

  • 在本地IDE中导入 from jqdatasdk import * 后,您就可以直接使用 Ctrl + 鼠标左键(Mac为 Cmd + 鼠标左键)点击函数名,跳转到 jqdatasdk 的存根文件(stub)中,清晰地看到所有参数的定义和类型提示。

总结:在聚宽网页端,虽然不能直接看底层源码,但利用 Shift + Tab? 是最符合Jupyter使用习惯、也是最快获取参数列表的方法,完全可以替代查阅官方文档的需求。