github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-26 05:03:09 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #65982 from deads2k/cli-02-outputdefaulting

Browse Source 
Automatic merge from submit-queue (batch tested with PRs 64695, 65982, 65908). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>.

re-make print flags composeable for sophisticated callers

Composers need to override all the pieces of logic independently.  It also simplifies the determination logic.

@kubernetes/sig-cli-maintainers 
/assign @juanvallejo 

```release-note
NONE
```
This commit is contained in:
Kubernetes Submit Queue 2018-07-10 08:55:10 -07:00 committed by GitHub
commit 4855bd0fc8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
pkg/kubectl/genericclioptions/print_flags.go
View File

@ -22,7 +22,6 @@ import (
"strings" "strings"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/spf13/pflag"
"k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/runtime"
"k8s.io/kubernetes/pkg/kubectl/genericclioptions/printers" "k8s.io/kubernetes/pkg/kubectl/genericclioptions/printers"
@ -63,9 +62,11 @@ type PrintFlags struct {
TypeSetterPrinter *printers.TypeSetterPrinter TypeSetterPrinter *printers.TypeSetterPrinter
OutputFormat *string OutputFormat *string
outputFlag *pflag.Flag
outputDefaulted bool // OutputFlagSpecified indicates whether the user specifically requested a certain kind of output.
// Using this function allows a sophisticated caller to change the flag binding logic if they so desire.
OutputFlagSpecified func() bool
} }
func (f *PrintFlags) Complete(successTemplate string) error { func (f *PrintFlags) Complete(successTemplate string) error {
@ -86,11 +87,13 @@ func (f *PrintFlags) ToPrinter() (printers.ResourcePrinter, error) {
outputFormat = *f.OutputFormat outputFormat = *f.OutputFormat
} }
// For backwards compatibility we want to support a --template argument given, even when no --output format is provided. // For backwards compatibility we want to support a --template argument given, even when no --output format is provided.
// If a default output format has been set, but no explicit output format has been provided via the --output flag, fallback // If no explicit output format has been provided via the --output flag, fallback
// to honoring the --template argument. // to honoring the --template argument.
if f.TemplatePrinterFlags != nil && f.TemplatePrinterFlags.TemplateArgument != nil && templateFlagSpecified := f.TemplatePrinterFlags != nil &&
len(*f.TemplatePrinterFlags.TemplateArgument) > 0 && f.TemplatePrinterFlags.TemplateArgument != nil &&
(len(outputFormat) == 0 || (f.outputDefaulted && f.outputFlag != nil && !f.outputFlag.Changed)) { len(*f.TemplatePrinterFlags.TemplateArgument) > 0
outputFlagSpecified := f.OutputFlagSpecified != nil && f.OutputFlagSpecified()
if templateFlagSpecified && !outputFlagSpecified {
outputFormat = "go-template" outputFormat = "go-template"
} }
@ -122,14 +125,17 @@ func (f *PrintFlags) AddFlags(cmd *cobra.Command) {
if f.OutputFormat != nil { if f.OutputFormat != nil {
cmd.Flags().StringVarP(f.OutputFormat, "output", "o", *f.OutputFormat, fmt.Sprintf("Output format. One of: %s.", strings.Join(f.AllowedFormats(), "|"))) cmd.Flags().StringVarP(f.OutputFormat, "output", "o", *f.OutputFormat, fmt.Sprintf("Output format. One of: %s.", strings.Join(f.AllowedFormats(), "|")))
f.outputFlag = cmd.Flag("output") if f.OutputFlagSpecified == nil {
f.OutputFlagSpecified = func() bool {
return cmd.Flag("output").Changed
}
}
} }
} }
// WithDefaultOutput sets a default output format if one is not provided through a flag value // WithDefaultOutput sets a default output format if one is not provided through a flag value
func (f *PrintFlags) WithDefaultOutput(output string) *PrintFlags { func (f *PrintFlags) WithDefaultOutput(output string) *PrintFlags {
f.OutputFormat = &output f.OutputFormat = &output
f.outputDefaulted = true
return f return f
} }