Mercurial > gemma
changeset 4171:5a650cde0574
Move warning limiter to common package to flesh up the misc package.
The remaining stuff in misc has dependencies to the config
and cannot be removed from there easily w/o introducing
cyclic imports. I have to rethink this.
| author | Sascha L. Teichmann <sascha.teichmann@intevation.de> |
|---|---|
| date | Mon, 05 Aug 2019 16:43:31 +0200 |
| parents | afabd52212d2 |
| children | 9cbed444b8a4 d3fb2f37380b |
| files | pkg/common/warn.go pkg/imports/agm.go pkg/imports/sr.go pkg/misc/warn.go |
| diffstat | 4 files changed, 41 insertions(+), 36 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/pkg/common/warn.go Mon Aug 05 16:43:31 2019 +0200 @@ -0,0 +1,39 @@ +// This is Free Software under GNU Affero General Public License v >= 3.0 +// without warranty, see README.md and license for details. +// +// SPDX-License-Identifier: AGPL-3.0-or-later +// License-Filename: LICENSES/AGPL-3.0.txt +// +// Copyright (C) 2019 by via donau +// – Österreichische Wasserstraßen-Gesellschaft mbH +// Software engineering by Intevation GmbH +// +// Author(s): +// * Sascha L. Teichmann <sascha.teichmann@intevation.de> + +package common + +// WarningLimiter limits outputs with Log to a maximal number +// of MaxWarnings outputs. +type WarningLimiter struct { + Log func(format string, args ...interface{}) + MaxWarnings int + Warnings int +} + +// Warn is a wrapper around the Log function with the +// same signature as the Log function so it can be used +// instead. +func (w *WarningLimiter) Warn(format string, args ...interface{}) { + if w.Warnings++; w.Warnings <= w.MaxWarnings { + w.Log(format, args...) + } +} + +// Close can be called to write a final message if the limit +// was reached. +func (w *WarningLimiter) Close() { + if w.Warnings > w.MaxWarnings { + w.Log("Too many warnings. %d ignored.", w.Warnings-w.MaxWarnings) + } +}
--- a/pkg/imports/agm.go Mon Aug 05 16:30:55 2019 +0200 +++ b/pkg/imports/agm.go Mon Aug 05 16:43:31 2019 +0200 @@ -32,7 +32,6 @@ "time" "gemma.intevation.de/gemma/pkg/common" - "gemma.intevation.de/gemma/pkg/misc" "gemma.intevation.de/gemma/pkg/models" ) @@ -308,7 +307,7 @@ checkedGauges := map[models.Isrs]bool{} - warnLimiter := misc.WarningLimiter{Log: feedback.Warn, MaxWarnings: 100} + warnLimiter := common.WarningLimiter{Log: feedback.Warn, MaxWarnings: 100} warn := warnLimiter.Warn defer warnLimiter.Close()
--- a/pkg/imports/sr.go Mon Aug 05 16:30:55 2019 +0200 +++ b/pkg/imports/sr.go Mon Aug 05 16:43:31 2019 +0200 @@ -35,7 +35,6 @@ shp "github.com/jonas-p/go-shp" "gemma.intevation.de/gemma/pkg/common" - "gemma.intevation.de/gemma/pkg/misc" "gemma.intevation.de/gemma/pkg/models" "gemma.intevation.de/gemma/pkg/octree" ) @@ -733,7 +732,7 @@ mpz := make(octree.MultiPointZ, 0, 250000) s := bufio.NewScanner(r) - warnLimiter := misc.WarningLimiter{Log: feedback.Warn, MaxWarnings: 100} + warnLimiter := common.WarningLimiter{Log: feedback.Warn, MaxWarnings: 100} warn := warnLimiter.Warn defer warnLimiter.Close()
--- a/pkg/misc/warn.go Mon Aug 05 16:30:55 2019 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,32 +0,0 @@ -// This is Free Software under GNU Affero General Public License v >= 3.0 -// without warranty, see README.md and license for details. -// -// SPDX-License-Identifier: AGPL-3.0-or-later -// License-Filename: LICENSES/AGPL-3.0.txt -// -// Copyright (C) 2019 by via donau -// – Österreichische Wasserstraßen-Gesellschaft mbH -// Software engineering by Intevation GmbH -// -// Author(s): -// * Sascha L. Teichmann <sascha.teichmann@intevation.de> - -package misc - -type WarningLimiter struct { - Log func(format string, args ...interface{}) - MaxWarnings int - Warnings int -} - -func (w *WarningLimiter) Warn(format string, args ...interface{}) { - if w.Warnings++; w.Warnings <= w.MaxWarnings { - w.Log(format, args...) - } -} - -func (w *WarningLimiter) Close() { - if w.Warnings > w.MaxWarnings { - w.Log("Too many warnings. %d ignored.", w.Warnings-w.MaxWarnings) - } -}