You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

Python Click中如何完整显示子命令的帮助文本?

解决Click CLI主命令中子命令帮助文本被截断的问题

Click默认会限制帮助文本的显示宽度,当子命令的帮助文本过长时,会自动截断并以省略号代替,这就是你遇到的问题。以下是两种解决方法:

方法一:增大主命令的帮助文本宽度限制

通过给主命令的context_settings参数设置max_content_width,调整允许显示的最大宽度,确保完整的帮助文本能展示出来:

import click

@click.group(context_settings={"max_content_width": 120})
def main():
    pass

@main.command()
def getq():
    '''Parameters: --questionnaire_id, --question_id, --session_id, --option_id''' 
    click.echo('Question Answers')

你可以根据实际文本长度调整max_content_width的值,只要超过你的帮助文本长度即可。

方法二:区分简短帮助与详细帮助

如果希望主命令的子命令列表保持简洁,可以给子命令设置short_help作为主命令中显示的简短描述,把完整的参数说明放在子命令的详细帮助里,用户执行子命令加--help时就能查看完整内容:

import click

@click.group()
def main():
    pass

@main.command(short_help="获取问卷答案(加--help查看参数)")
def getq():
    '''获取问卷答案
    
    参数说明:
        --questionnaire_id: 问卷ID
        --question_id: 问题ID
        --session_id: 会话ID
        --option_id: 选项ID
    ''' 
    click.echo('Question Answers')

内容的提问来源于stack exchange,提问作者lil_papa

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.08.06 03:30:42