yaml: typeError implements PrettyPrinter interface #280
Conversation
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
When unmarshalling YAML and encountering an error in decoded that results in a `yaml.typeError`, the error can't have the same nice formatting because it doesn't implement the `errors.PrettyPrinter` interface. This adds a field to the `yaml.typeError` struct that specifies a token which is used in the implementation of the PrettyPrinter interface. The tests were updated to instead match on expected message substrings instead of full equality.
braydonk
commented
Feb 9, 2022
| @@ -67,10 +67,10 @@ type wrapError struct { | |||
| frame xerrors.Frame | |||
| } | |||
|
|
|||
| type myprinter struct { | |||
| type FormatErrorPrinter struct { | |||
There was a problem hiding this comment.
This seemed like a nicer solution than declaring another identical type in decode.go for the printer struct, but I don't have to do it this way if that's preferred.
decode.go
Outdated
| @@ -417,8 +419,31 @@ func (e *typeError) Error() string { | |||
| return fmt.Sprintf("cannot unmarshal %s into Go value of type %s", e.srcType, e.dstType) | |||
| } | |||
|
|
|||
| func errTypeMismatch(dstType, srcType reflect.Type) *typeError { | |||
| return &typeError{dstType: dstType, srcType: srcType} | |||
| func (e *typeError) PrettyPrint(p xerrors.Printer, colored, inclSource bool) error { | |||
There was a problem hiding this comment.
I'd also considered moving typeError to the internal/errors package, which is where the other PrettyPrinter errors are. I left it here for now, but am interested if you would prefer this or the alternative.
There was a problem hiding this comment.
As you say, it seems better to move to internal/errors so that the processing can be standardized. Could you please ?
|
Thank you for the contribution and very nice feature !! |
The typeError previously located in decode.go now implements PrettyPrinter, so it's been moved to internal/errors to be colocated with the other PrettyPrinter errors.
|
LGTM !! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When unmarshalling YAML and encountering an error in decoding that
results in a
yaml.typeError, the error can't have the same niceformatting because it doesn't implement the
errors.PrettyPrinterinterface. This adds a field to the
yaml.typeErrorstruct thatspecifies a token which is used in the implementation of the
PrettyPrinter interface. The tests were updated to instead match on
expected message substrings instead of full equality.
For example, when getting an error like this:
cannot unmarshal uint64 into Go struct field T.B of type time.DurationThis PR allows for output like this: