当前位置:首页 > 文章列表 > Golang > Go问答 > 在 Cobra CLI 中如何将命令执行结果传递给 Postrun

在 Cobra CLI 中如何将命令执行结果传递给 Postrun

来源:stackoverflow 2024-03-20 16:48:33 0浏览 收藏

Cobra CLI 支持在命令执行后调用 PostRun,但如何将命令状态传递给 PostRun 调用呢?一种方法是利用 Cobra 命令中提供的注释。在 run 函数中设置注释,并在 PostRun 函数中检索这些注释。另一种方法是使用高阶函数包装 run 和 PostRun 函数,以捕获错误或恐慌,然后将它们传递到 PostRun 中。

问题内容

Cobra CLI 支持在执行命令后调用 PostRun。

https://github.com/spf13/cobra#prerun-and-postrun-hooks

如何将命令状态传递给 PostRun 调用? 我需要在执行后将命令状态发布到服务器


正确答案


更简洁的方法是利用 cobra 命令中提供的注释

package main

import (
    "fmt"

    "github.com/spf13/cobra"
)


func main() {
    var rootcmd = &cobra.command{
        use:   "root [sub]",
        short: "my root command",
        run: func(cmd *cobra.command, args []string) {
            // do your processing here
            // set the command annotations
            cmd.annotations = make(map[string]string)
            cmd.annotations["status"] = "status_goes_here"
            cmd.annotations["error"] = "error_goes_here"
        },
        postrun: func(cmd *cobra.command, args []string) {
            // retrieve the annotations
            fmt.println(cmd.annotations["status"])
            fmt.println(cmd.annotations["error"])
        },
    }

    rootcmd.setargs([]string{"sub", "arg1", "arg2"})
    rootcmd.execute()
}

真的很喜欢@bracken在这里采取的方法,尽管有一些调整可以使其发挥作用

package main

import (
    "fmt"
    "errors"

    "github.com/spf13/cobra"
)

type wrapper struct {
    err error
}

// rune fails to proceed further in case of error resulting in not executing postrun actions
func (w *wrapper) run(f func(cmd *cobra.command, args []string) error) func(cmd *cobra.command, args []string) {
    return func(cmd *cobra.command, args []string) {
        err := f(cmd, args)
        w.err = err
    }
}

func (w *wrapper) postrun(f func(cmd *cobra.command, args []string, cmderr error)) func(cmd *cobra.command, args []string) {
    return func(cmd *cobra.command, args []string) {
        f(cmd, args, w.err)
    }
}

func main() {
    cmdwrap := wrapper{}
    var rootcmd = &cobra.command{
        use:   "root [sub]",
        short: "my root command",
        run: cmdwrap.run(func(cmd *cobra.command, args []string) error {
            return errors.new("i'm not in the book, you know")
        }),
        postrun: cmdwrap.postrun(func(cmd *cobra.command, args []string, cmderr error) {
            fmt.printf("error was %v\n", cmderr)
        }),
    }

    rootcmd.setargs([]string{"sub", "arg1", "arg2"})
    rootcmd.execute()
}

-----旧答案-----

如果我理解正确的话,有一些状态需要从 cmd.execute 传递到 postrun。

您可以使用 executecontext(ctx context.context) 方法代替 execute() 并设置需要在上下文中设置的任何键值。

ctx := context.withvalue(context.background(), "status", "statusvalue")
rootcmd.executecontext(ctx)

可以使用 cmd.context() 在 postrun 内检索相同的值

postrun: func(cmd *cobra.command, args []string) {
   ctx := cmd.context()
   status := ctx.value("status")
}

我将使用高阶函数包装您的 run (或 rune)函数和 postrun 函数来捕获错误或恐慌,然后将它们传递到您的 postrun 中:

package main

import (
    "fmt"

    "github.com/spf13/cobra"
)

type wrapper struct {
    err error
}

func (w *wrapper) RunE(f func(cmd *cobra.Command, args []string) error) func(cmd *cobra.Command, args []string) error {
    return func(cmd *cobra.Command, args []string) (err error) {
        defer func() {
            if r := recover(); r != nil {
                err = fmt.Errorf("panic: %v", r)
                w.err = err
            }
        }()
        err = f(cmd, args)
        w.err = err
        return
    }
}

func (w *wrapper) PostRun(f func(cmd *cobra.Command, args []string, cmdErr error)) func(cmd *cobra.Command, args []string) {
    return func(cmd *cobra.Command, args []string) {
        f(cmd, args, w.err)
    }
}

func main() {
    cmdWrap := wrapper{}
    var cmdFail = &cobra.Command{
        Use:   "fail",
        Short: "Doesn't work",
        RunE: cmdWrap.RunE(func(cmd *cobra.Command, args []string) error {
            panic("i'm not in the book, you know")
        }),
        PostRun: cmdWrap.PostRun(func(cmd *cobra.Command, args []string, cmdErr error) {
            fmt.Printf("error was %v\n", cmdErr)
        }),
    }

    var rootCmd = &cobra.Command{}
    rootCmd.AddCommand(cmdFail)
    rootCmd.Execute()
}

到这里,我们也就讲完了《在 Cobra CLI 中如何将命令执行结果传递给 Postrun》的内容了。个人认为,基础知识的学习和巩固,是为了更好的将其运用到项目中,欢迎关注golang学习网公众号,带你了解更多关于的知识点!

版本声明
本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
备份 Minecraft 服务器时,离线状态下使用 tar 等工具会损坏文件吗?备份 Minecraft 服务器时,离线状态下使用 tar 等工具会损坏文件吗?
上一篇
备份 Minecraft 服务器时,离线状态下使用 tar 等工具会损坏文件吗?
确保Linux的用户密码文件的安全性
下一篇
确保Linux的用户密码文件的安全性
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ljg-skills -
    ljg-skills
    ljg-skills 是李继刚开源的 AI 技能与提示词集合,面向大模型使用者整理了一批可复用的 prompt、角色设定和任务技能模板,适合用于学习提示词设计、搭建个人 AI 工作流和沉淀团队常用智能体能力。
    587次使用
  • MELO音乐 - AI 音乐生成平台,支持多模态创作能力
    MELO音乐
    MELO音乐是一站式AI视频与音乐制作助手,对标suno, udio的高品质体验。提供伴奏生成、原创写词、无损导出、哼唱识曲、混音变声等全套音频与短视频编辑工具。无论是流行Kpop、电音说唱、民谣古风、摇滚儿歌还是商用轻音乐,MELO为你免费谱曲,轻松做同款!
    605次使用
  • UniScribe - AI 免费在线音视频转文字平台
    UniScribe
    UniScribe 是一款 AI 音视频转文字与内容整理工具,支持上传音频、视频文件或粘贴 YouTube 链接,自动生成转写文本、摘要、思维导图和关键问题,并支持多格式导出,适合会议记录、课程学习、访谈整理和内容创作复盘。
    570次使用
  • 剧云 - 免费 AI 智能中文剧本创作平台
    剧云
    剧云是专业中文剧本创作平台,安全稳定运行十余年,集成AI编剧、剧本医生审核、人物小传、剧情关系图、大纲编写、多人协作、Word导入导出、版权管控功能,数据安全防护,轻松高效创作剧本。
    732次使用
  • 万象有声 - AI 一站式有声内容创作平台
    万象有声
    万象有声,一个专为有声创作者打造的新一代智能有声内容创作平台。平台提供专业的智能拆章、智能画本编辑、AI配音、AI生成音效、后期制作、智能对轨、智能审听等有声创作全流程工具,可以帮助创作者高效、低成本创作出引人入胜的有声作品。立即体验,让有声书制作更简单!
    721次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码