go flags 下载 - go flags 源代码下载

走旗

其他源码

v1.6.1

下载

go-flags：用于解析命令行参数的 go 库

该库提供了与 go 内置标志库类似的功能，但提供了更多的功能和更好的格式。从文档中：

包 flags 提供了一个广泛的命令行选项解析器。 flags 包的功能与 go 内置 flag 包类似，但提供了更多选项，并使用反射来提供一种方便、简洁的方式来指定命令行选项。

支持的功能：

带有短名称的选项 (-v)
具有长名称的选项（--verbose）
带参数和不带参数的选项（bool 与其他类型）
带有可选参数和默认值的选项
多个选项组，每个选项组包含一组选项
生成并打印格式正确的帮助消息
在 -- 之后传递剩余的命令行参数（可选）
忽略未知的命令行选项（可选）
支持 -I/usr/include -I=/usr/include -I /usr/include 选项参数规范
支持多个短选项 -aux
支持所有原始 Go 类型（string、int{8..64}、uint{8..64}、float）
支持多次相同选项（可以存储在切片或最后一个选项计数中）
支持地图
支持函数回调
支持（嵌套）选项组的命名空间

flags 包使用结构体、反射和结构体字段标签来允许用户指定命令行选项。这使得您的应用程序选项的规范非常简单和简洁。例如：

 type Options struct {
	Verbose [] bool `short:"v" long:"verbose" description:"Show verbose debug information"`
}

这指定了一个带有短名称 -v 和长名称 --verbose 的选项。当在命令行上找到 -v 或 --verbose 时，“true”值将附加到 Verbose 字段。例如，当指定 -vvv 时，Verbose 的结果值为 {[true, true, true]}。

例子：

to call a number. // Note that this works just on OS X (and probably only with // Skype) but it shows the idea. opts.Call = func(num string) { cmd := exec.Command("open", "callto:"+num) cmd.Start() cmd.Process.Release() } // Make some fake arguments to parse. args := []string{ "-vv", "--offset=5", "-n", "Me", "--animal", "dog", // anything other than "cat" or "dog" will raise an error "-p", "3", "-s", "hello", "-s", "world", "--ptrslice", "hello", "--ptrslice", "world", "--intmap", "a:1", "--intmap", "b:5", "arg1", "arg2", "arg3", } // Parse flags from `args'. Note that here we use flags.ParseArgs for // the sake of making a working example. Normally, you would simply use // flags.Parse(&opts) which uses os.Args args, err := flags.ParseArgs(&opts, args) if err != nil { panic(err) } fmt.Printf("Verbosity: %vn", opts.Verbose) fmt.Printf("Offset: %dn", opts.Offset) fmt.Printf("Name: %sn", opts.Name) fmt.Printf("Animal: %sn", opts.Animal) fmt.Printf("Ptr: %dn", *opts.Ptr) fmt.Printf("StringSlice: %vn", opts.StringSlice) fmt.Printf("PtrSlice: [%v %v]n", *opts.PtrSlice[0], *opts.PtrSlice[1]) fmt.Printf("IntMap: [a:%v b:%v]n", opts.IntMap["a"], opts.IntMap["b"]) fmt.Printf("Remaining args: %sn", strings.Join(args, " ")) // Output: Verbosity: [true true] // Offset: 5 // Name: Me // Ptr: 3 // StringSlice: [hello world] // PtrSlice: [hello world] // IntMap: [a:1 b:5] // Remaining args: arg1 arg2 arg3">

 var opts struct {
	// Slice of bool will append 'true' each time the option
	// is encountered (can be set multiple times, like -vvv)
	Verbose [] bool `short:"v" long:"verbose" description:"Show verbose debug information"`

	// Example of automatic marshalling to desired type (uint)
	Offset uint `long:"offset" description:"Offset"`

	// Example of a callback, called each time the option is found.
	Call func ( string ) `short:"c" description:"Call phone number"`

	// Example of a required flag
	Name string `short:"n" long:"name" description:"A name" required:"true"`

	// Example of a flag restricted to a pre-defined set of strings
	Animal string `long:"animal" choice:"cat" choice:"dog"`

	// Example of a value name
	File string `short:"f" long:"file" description:"A file" value-name:"FILE"`

	// Example of a pointer
	Ptr * int `short:"p" description:"A pointer to an integer"`

	// Example of a slice of strings
	StringSlice [] string `short:"s" description:"A slice of strings"`

	// Example of a slice of pointers
	PtrSlice [] * string `long:"ptrslice" description:"A slice of pointers to string"`

	// Example of a map
	IntMap map [ string ] int `long:"intmap" description:"A map from string to int"`

	// Example of env variable
	Thresholds  [] int     `long:"thresholds" default:"1" default:"2" env:"THRESHOLD_VALUES"  env-delim:","`
}

// Callback which will invoke callto: to call a number.
// Note that this works just on OS X (and probably only with
// Skype) but it shows the idea.
opts . Call = func ( num string ) {
	cmd := exec . Command ( "open" , "callto:" + num )
	cmd . Start ()
	cmd . Process . Release ()
}

// Make some fake arguments to parse.
args := [] string {
	"-vv" ,
	"--offset=5" ,
	"-n" , "Me" ,
	"--animal" , "dog" , // anything other than "cat" or "dog" will raise an error
	"-p" , "3" ,
	"-s" , "hello" ,
	"-s" , "world" ,
	"--ptrslice" , "hello" ,
	"--ptrslice" , "world" ,
	"--intmap" , "a:1" ,
	"--intmap" , "b:5" ,
	"arg1" ,
	"arg2" ,
	"arg3" ,
}

// Parse flags from `args'. Note that here we use flags.ParseArgs for
// the sake of making a working example. Normally, you would simply use
// flags.Parse(&opts) which uses os.Args
args , err := flags . ParseArgs ( & opts , args )

if err != nil {
	panic ( err )
}

fmt . Printf ( "Verbosity: %v n " , opts . Verbose )
fmt . Printf ( "Offset: %d n " , opts . Offset )
fmt . Printf ( "Name: %s n " , opts . Name )
fmt . Printf ( "Animal: %s n " , opts . Animal )
fmt . Printf ( "Ptr: %d n " , * opts . Ptr )
fmt . Printf ( "StringSlice: %v n " , opts . StringSlice )
fmt . Printf ( "PtrSlice: [%v %v] n " , * opts . PtrSlice [ 0 ], * opts . PtrSlice [ 1 ])
fmt . Printf ( "IntMap: [a:%v b:%v] n " , opts . IntMap [ "a" ], opts . IntMap [ "b" ])
fmt . Printf ( "Remaining args: %s n " , strings . Join ( args , " " ))

// Output: Verbosity: [true true]
// Offset: 5
// Name: Me
// Ptr: 3
// StringSlice: [hello world]
// PtrSlice: [hello world]
// IntMap: [a:1 b:5]
// Remaining args: arg1 arg2 arg3