اذهب الأعلام

go-flags: مكتبة go لتحليل وسيطات سطر الأوامر

توفر هذه المكتبة وظائف مشابهة لمكتبة العلم المضمنة في go، ولكنها توفر المزيد من الوظائف وتنسيقًا أفضل. من الوثائق:

توفر علامات الحزمة محللًا شاملاً لخيارات سطر الأوامر. تتشابه حزمة الأعلام في وظائفها مع حزمة go المدمج في العلم ولكنها توفر المزيد من الخيارات وتستخدم الانعكاس لتوفير طريقة ملائمة وموجزة لتحديد خيارات سطر الأوامر.

الميزات المدعومة:

• الخيارات ذات الأسماء القصيرة (-v)
• الخيارات ذات الأسماء الطويلة (--مطول)
• الخيارات مع وبدون الوسائط (bool مقابل النوع الآخر)
• خيارات ذات وسيطات اختيارية وقيم افتراضية
• مجموعات خيارات متعددة تحتوي كل منها على مجموعة من الخيارات
• إنشاء وطباعة رسالة مساعدة جيدة التنسيق
• تمرير وسيطات سطر الأوامر المتبقية بعد -- (اختياري)
• تجاهل خيارات سطر الأوامر غير المعروفة (اختياري)
• يدعم -I/usr/include -I=/usr/include -I /usr/include مواصفات وسيطة الخيار
• يدعم خيارات قصيرة متعددة -aux
• يدعم جميع أنواع الانتقال البدائية (string، int{8..64}، uint{8..64}، float)
• يدعم نفس الخيار عدة مرات (يمكن تخزينه في شرائح أو عدد الخيارات الأخيرة)
• يدعم الخرائط
• يدعم عمليات الاسترجاعات الوظيفية
• يدعم مساحات الأسماء لمجموعات الخيارات (المتداخلة).

تستخدم حزمة العلامات العلامات البنيوية والانعكاسية وحقول البنية للسماح للمستخدمين بتحديد خيارات سطر الأوامر. وينتج عن هذا مواصفات بسيطة وموجزة للغاية لخيارات التطبيق الخاصة بك. على سبيل المثال:

 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" style=";text-align:right;direction:rtl">

 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

يمكن العثور على مزيد من المعلومات في godocs: http://godoc.org/github.com/jessevdk/go-flags