-
Notifications
You must be signed in to change notification settings - Fork 38.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Generic way to import 'flag' flags into the 'pflag' system. #3342
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
/* | ||
Copyright 2015 Google Inc. All rights reserved. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package util | ||
|
||
import ( | ||
"flag" | ||
"reflect" | ||
"strings" | ||
|
||
"github.com/spf13/pflag" | ||
) | ||
|
||
// flagValueWrapper implements pflag.Value around a flag.Value. The main | ||
// difference here is the addition of the Type method that returns a string | ||
// name of the type. As this is generally unknown, we approximate that with | ||
// reflection. | ||
type flagValueWrapper struct { | ||
inner flag.Value | ||
flagType string | ||
} | ||
|
||
func wrapFlagValue(v flag.Value) pflag.Value { | ||
// If the flag.Value happens to also be a pflag.Value, just use it directly. | ||
if pv, ok := v.(pflag.Value); ok { | ||
return pv | ||
} | ||
|
||
pv := &flagValueWrapper{ | ||
inner: v, | ||
} | ||
pv.flagType = reflect.TypeOf(v).Elem().Name() | ||
pv.flagType = strings.TrimSuffix(pv.flagType, "Value") | ||
return pv | ||
} | ||
|
||
func (v *flagValueWrapper) String() string { | ||
return v.inner.String() | ||
} | ||
|
||
func (v *flagValueWrapper) Set(s string) error { | ||
return v.inner.Set(s) | ||
} | ||
|
||
func (v *flagValueWrapper) Type() string { | ||
return v.flagType | ||
} | ||
|
||
// Imports a 'flag.Flag' into a 'pflag.FlagSet'. The "short" option is unset | ||
// and the type is inferred using reflection. | ||
func AddFlagToPFlagSet(f *flag.Flag, fs *pflag.FlagSet) { | ||
fs.Var(wrapFlagValue(f.Value), f.Name, f.Usage) | ||
} | ||
|
||
// Adds all of the flags in a 'flag.FlagSet' package flags to a 'pflag.FlagSet'. | ||
func AddFlagSetToPFlagSet(fsIn *flag.FlagSet, fsOut *pflag.FlagSet) { | ||
fsIn.VisitAll(func(f *flag.Flag) { | ||
AddFlagToPFlagSet(f, fsOut) | ||
}) | ||
} | ||
|
||
// Adds all of the top level 'flag' package flags to a 'pflag.FlagSet'. | ||
func AddAllFlagsToPFlagSet(fs *pflag.FlagSet) { | ||
AddFlagSetToPFlagSet(flag.CommandLine, fs) | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is kinda broken for my quantity flag (https://github.com/GoogleCloudPlatform/kubernetes/blob/master/pkg/api/resource/quantity.go#L405)... not sure what to do about that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah - I'm not sure what to do here. Honestly, I'm not sure what anyone uses the "Type" method for in pflag.
If/When we switch everything over to pflag we can add a "Type" there.
Another option, if the flag.Value already is convertable to a pflag.Value type, we can just use it directly and not wrap. Not sure it is worth the effort though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, here's a suggestion: start off with:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done.