55 Commits

Author SHA1 Message Date
Alexey Palazhchenko
cc5fbb72d9 Documentation improvements (#69)
* Add install instructions.

* Document that causer and stackTracer are stable.
2016-07-19 19:13:40 +10:00
Jon Gillham
d62207b3dc Capitalise first letter of trace. (#60) 2016-06-27 12:13:31 +10:00
Darshan Shaligram
cbd18b5440 Fix %q format for wrapped errors (#58)
Not handling the %q format causes logrus to log empty error strings for
wrapped errors where x.Error() contains spaces or other quoteworthy
characters.

For reference, the logrus formatter does this:
https://github.com/Sirupsen/logrus/blob/master/text_formatter.go#L154
2016-06-22 11:00:19 +10:00
Dave Cheney
0bc61eb85b Wrapper errors now print full stacktrace (#57) 2016-06-19 14:34:20 +10:00
Dave Cheney
494e70f762 Rename StackTrace interface to stacktracer in docs and examples (#56) 2016-06-16 17:40:57 +10:00
Uwe Dauernheim
01fa4104b9 Align code example documentation (#52) 2016-06-13 12:17:47 +10:00
Dave Cheney
73d71e4a6a Rename Stacktrace to StackTrace (#51)
Fixes #50
2016-06-13 11:11:14 +10:00
Dave Cheney
784931b43c rename errors.New parameter to message 2016-06-13 10:58:08 +10:00
Dave Cheney
9a4f977a05 document extended format 2016-06-11 23:12:34 +10:00
Dave Cheney
7896481a53 Extended stacktrace output (#49)
* Extended stacktrace output

* Make format tests less sensitive to sourcecode prefix

* use testFormatRegexp for all Sprintf tests

* replace output test with sample output

* work around the different fn.Name format in go 1.4

* fix windows tests when there is a drive letter in the source path
2016-06-11 23:04:57 +10:00
Dave Cheney
7f46da032a update godoc 2016-06-11 15:57:15 +10:00
Dave Cheney
c5fe904864 update godoc 2016-06-11 15:54:49 +10:00
Dave Cheney
d7cdef1704 Remove Fprint (#47) 2016-06-10 11:53:11 +10:00
Dave Cheney
874c0ec5b0 Reimplement Fprint in terms of fmt.Fprintf (#44)
This PR follows on from #40 completely implementing Fprint in terms of
fmt.Fprintf. This will be the final PR before Fprint is removed.
2016-06-10 08:39:59 +10:00
Dave Cheney
3dc37da2ca Reverse the order of Fprint output (#43)
Fprint should match the stack output, innermost error first.

It probably doesn't matter as Fprint is going away.
2016-06-09 20:02:11 +10:00
Dave Cheney
c0c662e216 Use fmt.Formatter throughout (#40)
* Use fmt.Formatter throughout

Replace Fprintf with fmt.Formatter logic on various types. This
effectively guts Fprint to be just a recursive call down the err.Cause
chain. The next step will be to move this recursive logic into
wrapper.Format.

This change necessitates adding types for the error impls returned from
New and Errorf, and Wrap and Wrapf, respectively. The name of the latter
type is acceptable, the former is not and alternative suggestions are
encouraged.

- Remove cause.Format
- Added fmt.Formatter tests. The location is temporary, once this PR is merged and Fprint removed
they will be merged into errors_test.go
2016-06-09 16:45:08 +10:00
Dave Cheney
2af433a3bd Remove Message interface (#39)
Replace Message with a Format method on cause. This simplifies Fprint as
well as removing one interface method from Wrap/Wrapf error impls.
2016-06-08 20:37:09 +10:00
Dave Cheney
d146efd52a relocate cause 2016-06-08 20:25:18 +10:00
Dave Cheney
19140ea8c4 Remove deprecated Location interface 2016-06-08 19:34:10 +10:00
Dave Cheney
3cdd33210d Introduce Stacktrace and Frame (#37)
* Introduce Stacktrace and Frame

This PR is a continuation of a series aimed at exposing the stack trace
information embedded in each error value. The secondary effect is to
deprecated the `Fprintf` helper.

Taking cues from from @chrishines' `stack` package this PR introduces a
new interface `Stacktrace() []Frame` and a `Frame` type, similar in
function to the `runtime.Frame` type (although lacking its iterator
type). Each `Frame` implemnts `fmt.Formatter` allowing it to print
itself.

The older `Location` interface is still supported but also deprecated.
2016-06-07 14:23:05 +10:00
Dave Cheney
b700c3e918 fix typo 2016-06-06 20:27:34 +10:00
Dave Cheney
431554f80b Remove errors.wrap helper
`errors.wrap` existed to avoid the conflict between the type,
`errors.cause` and the formal parameter `cause`. The parameter was
renamed to err in #32 so there is no need for the helper.
2016-05-26 15:24:04 +10:00
Mat Ryer
936b5d744d renamed cause argument to err - fixes #32 (#33) 2016-05-25 09:59:37 +10:00
Dave Cheney
e8c21980b6 Make errors.stack comparable (#30)
Fixed #29

errors.New, etc values are not expected to be compared by value but
the change in errors#27 made them incomparable. Assert that various
kinds of errors have a functional equality operator, even if the
result of that equality is always false.
2016-05-24 12:36:43 +10:00
Dave Cheney
cc157cd49f Store the stack of the caller to New, Errorf, Wrap and Wrapf (#27)
Store up to 32 stack frames for the caller to New, Errorf, Wrap, and
Wrapf.
2016-05-23 18:47:43 +10:00
Dave Cheney
567ccaadc6 Split stack.Location into a private helper 2016-05-23 17:36:45 +10:00
Dave Cheney
80cce0ee9b Rename errors.location to errors.stack (#26) 2016-05-23 17:32:36 +10:00
Dave Cheney
daa1017c6f Refactor errors.location to be a stack of callers (#25)
Refactory errors.location to be a stack of callers rather than the
topmost caller. This is in perparation for storing the entire error
stack inside topmost error.
2016-05-23 17:10:14 +10:00
Dave Cheney
d814416a46 update package description (#24) 2016-05-11 07:41:07 +10:00
Dave Cheney
01fff4b066 Remove errors.Print (#23)
errors.Print had a number of problems. Firstly, it was hard coded to
print to os.Stderr, which made it difficult to test, and hard to write
an example test for. Secondly, comments made in issue #20 make it clear
that helpers need to have a high bar for inclusion in this package, and
something that wrapped errors.Fprint in a way that was hard to test
fails that bar.

So, Remove errors.Print, which frees the identifier for being reused
later, and reduces the size of the package.
2016-05-10 11:02:00 +10:00
Jud White
0d62637d04 errors.go: "nor" -> "not" (typo fix) (#17) 2016-05-04 06:53:04 +08:00
Santiago Corredoira Lascaray
7a0abd8f63 Add Errorf (#14) 2016-04-30 08:38:57 +10:00
Dave Cheney
cd6e0b425d address spelling mistakes. Thanks @seh 2016-04-27 10:39:47 +10:00
Dave Cheney
7efa461bd3 Fix spelling mistake in comment 2016-04-26 12:27:40 +10:00
Dave Cheney
3612ec480e Remove the errors.e type (#11)
* rename loc type to location

* move locationer interface inside Fprint, rename to location

* refactor Wrap/Wrapf into helper method

* remove errors.e type, compose an anon struct in wrap and add a Message() interface method to extract the cause message
2016-04-26 12:25:34 +10:00
Dave Cheney
f85d45fecf Merge pull request #7 from umairidris/wrapf
Add Wrapf
2016-04-25 13:42:03 +09:00
Umair Idris
9a179122f1 Add Wrapf 2016-04-25 00:31:25 -04:00
Chris Hines
046fc1474d Updates from code review. 2016-04-24 21:36:07 -04:00
Chris Hines
665006faab Infer compile time GOPATH from fn.Name(). 2016-04-24 20:49:56 -04:00
Dave Cheney
ab94cc2ab2 fix loc.Location, re-enable tip 2016-04-25 07:42:30 +09:00
Umair Idris
c94cbcebe9 gofmt and typo fix 2016-04-24 15:34:22 -04:00
Dave Cheney
1c843d4ac5 spelling 2016-04-24 20:57:12 +09:00
Dave Cheney
bca5e1997f readme 2016-04-24 20:55:50 +09:00
Dave Cheney
326e08fb88 godoc 2016-04-24 20:53:36 +09:00
Anthony Yeh
44b2f1e7ac Don't pass arbitrary strings as Errorf() format strings.
Sometimes they happen to contain format specifiers, which results in
things like "%!v(MISSING)".
2016-04-24 00:08:22 -07:00
Dave Cheney
9eacf05e26 update package doc 2016-04-23 14:27:48 +09:00
Dave Cheney
109ee590a8 simplify pc 2016-04-22 19:32:12 +09:00
Dave Cheney
a7f2be0bfe added godoc 2016-04-22 19:10:04 +09:00
Dave Cheney
5a0856ff23 fixed tests, add coverage for Wrap and Fprintf 2016-04-22 17:27:54 +09:00
Dave Cheney
c978824ef0 wip 2016-04-20 13:14:31 +09:00